Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 50 lines (35 sloc) 1.909 kB
64b90e1 @titanous Add build status readme
titanous authored
1 # tentd ![Build Status](https://magnum.travis-ci.com/tent/tentd.png?branch=master&token=YmxLSPgdpsxNUMWJpzRx)
dca202c @titanous Initializing...
titanous authored
2
64b90e1 @titanous Add build status readme
titanous authored
3 tentd is an **alpha** implementation of a [Tent Protocol](http://tent.io) server.
673efce @titanous Add readme
titanous authored
4 It currently contains **broken code, ugly code, many bugs, and security flaws**.
5 The code should only be used to experiment with how Tent works. Under no
6 circumstances should the code in its current form be used for data that is
7 supposed to be private. All of the implemented APIs are in flux, and are
8 expected to change heavily before the Tent 1.0 release.
dca202c @titanous Initializing...
titanous authored
9
10
673efce @titanous Add readme
titanous authored
11 ## Requirements
dca202c @titanous Initializing...
titanous authored
12
673efce @titanous Add readme
titanous authored
13 TentD is written using Ruby 1.9 with Rack and Datamapper and is only tested with
14 PostgreSQL. The code needs a few fixes to work with 1.8 and other databases.
dca202c @titanous Initializing...
titanous authored
15
673efce @titanous Add readme
titanous authored
16 If you have Ruby 1.9, Bundler, and PostgreSQL installed, this should get the
17 tests running:
dca202c @titanous Initializing...
titanous authored
18
673efce @titanous Add readme
titanous authored
19 ```shell
20 createdb tent_server_test
21 bundle install
22 rake
23 ```
dca202c @titanous Initializing...
titanous authored
24
673efce @titanous Add readme
titanous authored
25 If you want to run this as a Tent server, you should use
26 [tentd-admin](https://github.com/tent/tentd-admin).
dca202c @titanous Initializing...
titanous authored
27
28
673efce @titanous Add readme
titanous authored
29 ## Contributions
dca202c @titanous Initializing...
titanous authored
30
673efce @titanous Add readme
titanous authored
31 If you want to help out with the TentD code instead of writing Tent clients and
32 applications, here are some areas that can be worked on:
dca202c @titanous Initializing...
titanous authored
33
673efce @titanous Add readme
titanous authored
34 - Fix database queries. There are a bunch of suboptimal uses of the database,
35 and basically no indexes. Low hanging fruit would be to turn on logging while
36 running the tests and index all the queries.
37 - Add data validation/normalization.
38 - Audit security.
39 - Refactor. The current code was hacked together quickly and is pretty ugly.
40 - Add tests. There are quite a few areas that aren't tested completely.
41 - Fix tests. A lot of tests are written as integration tests and depend on the
42 database, many would be much faster as unit tests that don't hit the database.
957d053 @titanous Clarify contributions
titanous authored
43
44 Please note that we are not looking for Pull Requests that make fundamental
45 changes to how the Tent Protocol works.
3096c95 @titanous Add contributors section to the readme
titanous authored
46
47 ### Contributors
48
49 - [Jonas Schneider](https://github.com/jonasschneider)
Something went wrong with that request. Please try again.