Skip to content

Commit 2b7acfc

Browse files
committed
Added project files
1 parent 7747b5b commit 2b7acfc

7 files changed

+115
-0
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.swp
2+
*.lock
3+
target/
4+
*.bk

.travis.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
language: rust
2+
sudo: false
3+
rust:
4+
- stable
5+
- beta
6+
- nightly
7+
services:
8+
- redis-server
9+
notifications:
10+
irc:
11+
channels:
12+
- "chat.freenode.net#coredump"
13+
on_success: change
14+
on_failure: always
15+
use_notice: true
16+
skip_join: true

AUTHORS.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributors
2+
3+
- Danilo Bargen (@dbrgn)
4+
- Raphael Nestler (@rnestler)

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributors Guideline
2+
3+
We're very happy if people contribute to our projects! To keep quality high,
4+
please adhere to the following standards though:
5+
6+
- **Always create a fork or branch** if you develop a new feature or fix. Then
7+
create a pull request against `master` to get the changes integrated.
8+
- **Run the tests** (`cargo test`) before committing and pushing your changes.
9+
- **Write meaningful commit messages**: First line of your commit message should be
10+
a very short summary in the imperative mood without any punctuation symbols
11+
(ideally 50 characters or less). After the first line of the commit message,
12+
add a blank line and then a more detailed explanation (when relevant).
13+
[This](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) is
14+
a nice blog post concerning git commit messages.
15+
- **Keep your commit history clean**. If there are typo commits that should be squashed
16+
or if you want to re-order commits, please use `git rebase -i` or `git commit --amend`
17+
to clean up your commit history.
18+
19+
If you're a member of the development team (having push access to the repository):
20+
21+
- Create a pull request, then wait for another member of the team to review
22+
your changes. Only merge your PR if you got a "good to merge" comment.
23+
- Don't merge the pull requests of other members of the development team.
24+
Instead, let them know that you think their contribution is good to merge.
25+
26+
If you're an outside contributor:
27+
28+
- Simply create a pull request and wait for a team member to merge it.

LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014-2015 coredump Rapperswil
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Rust Space API Implementation
2+
3+
[![Build Status](https://travis-ci.org/coredump-ch/spaceapi-server-rs.svg?branch=master)](https://travis-ci.org/coredump-ch/spaceapi-server-rs)
4+
5+
This is a library that allows an easy implementation of a
6+
[SpaceAPI](http://spaceapi.net/) v0.13 server in Rust.
7+
8+
Space API Reference: http://spaceapi.net/documentation
9+
10+
11+
## Usage
12+
13+
TODO
14+
15+
16+
## Datastores
17+
18+
### Redis
19+
20+
To use the redis storage start the redis server:
21+
22+
$ redis-server
23+
24+
(...or start it using your favorite init daemon.)
25+
26+
You can access the database with the `redis-cli` tool:
27+
28+
% redis-cli
29+
127.0.0.1:6379> SET people_present 1
30+
OK
31+
127.0.0.1:6379> GET people_present
32+
"1"
33+
127.0.0.1:6379> KEYS *
34+
1) "people_present"
35+
36+
The values depend on your sensors configuration.
37+
38+
39+
## Docs
40+
41+
You can build docs with `make docs`. Find them in the `target/doc/` directory.

rustfmt.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
max_width = 110

0 commit comments

Comments
 (0)