readme: add information section
[nit.git] / contrib / tnitter / README.md
1 Tnitter, a Twitter-like micro-blogging platform
2
3 # Compile and execute
4
5 Make sure all the required packages are installed with: `apt-get install libevent-dev libsqlite3-dev`
6
7 To compile, run: `make`
8
9 To execute, run: `bin/tnitter`
10
11 The Web interface will be accessible at http://localhost:8080/
12
13 # Main server
14
15 The Tnitter application is deployed with other `nitcorn` projects at http://tnitter.xymus.net/
16
17 # Notable implementation details
18
19 * Implemented in Nit using the `nitcorn` framework.
20 * On the server side, besides `nitcorn` it uses the Nit modules `sqlite3`, `md5` and `privileges`
21 * The client-side UI is implemented with bootstrap 3.0 and jquery 1.11
22 * Passwords are salted and hashed, but sent in clear text to the server
23 * Launches on localhost on port 80 if running as root, on 8080 otherwise