various lib and contrib doc: points to new github repo
[nit.git] / contrib / opportunity / README.md
1 Opportunity is a web-application written in Nit to plan meetups with people in real-life (or on the internet, why not !).
2
3 It runs on Nit's official web server: Nitcorn, available along with the compiler for the language on Github <https://github.com/nitlang/nit>.
4
5 # Compile and execute
6
7 To compile the software, make sure you have all the dependencies for the Nit compiler at hand, make the compiler.
8
9 In addition to those, you will also need libevent-dev and libsqlite3-dev.
10
11 Under Debian or any Debian-based distribution of Linux, you can use apt-get install for those.
12 If you run an RPM based distribution, yum install should work as well.
13
14 For those who run an OSX-based system, macports or brew might have the packages you need to run Opportunity.
15
16 There is no support for Windows yet.
17
18 Then change directory to Opportunity, and use the command make here as well.
19
20 This will make an executable for opportunity in the bin folder that you can run from a terminal as usual.
21
22 # Features/TODO
23
24 - [x] Creation and visualization of Meetups
25 - [x] Adding people to meetups
26 - [x] Change answers
27 - [ ] Edit an Existing Meetup
28 - [ ] More security and stability for the software
29 - [ ] Full support of a REST API for eventual extern clients
30 - [ ] Maybe support another DB