opportunity: Added Makefile and README
authorLucas Bajolet <r4pass@hotmail.com>
Tue, 7 Oct 2014 14:19:04 +0000 (10:19 -0400)
committerLucas Bajolet <r4pass@hotmail.com>
Wed, 8 Oct 2014 14:59:42 +0000 (10:59 -0400)
Signed-off-by: Lucas Bajolet <r4pass@hotmail.com>

contrib/opportunity/Makefile [new file with mode: 0644]
contrib/opportunity/README.md [new file with mode: 0644]

diff --git a/contrib/opportunity/Makefile b/contrib/opportunity/Makefile
new file mode 100644 (file)
index 0000000..bbcf10b
--- /dev/null
@@ -0,0 +1,3 @@
+all:
+       mkdir -p bin/
+       ../../bin/nitg --dir bin/ src/opportunity_web.nit
diff --git a/contrib/opportunity/README.md b/contrib/opportunity/README.md
new file mode 100644 (file)
index 0000000..32eb786
--- /dev/null
@@ -0,0 +1,30 @@
+Opportunity is a web-application written in Nit to plan meetups with people in real-life (or on the internet, why not !).
+
+It runs on Nit's official web server: Nitcorn, available along with the compiler for the language on Github <https://github.com/privat/nit>.
+
+# Compile and execute
+
+To compile the software, make sure you have all the dependencies for the Nit compiler at hand, make the compiler.
+
+In addition to those, you will also need libevent-dev and libsqlite3-dev.
+
+Under Debian or any Debian-based distribution of Linux, you can use apt-get install for those.
+If you run an RPM based distribution, yum install should work as well.
+
+For those who run an OSX-based system, macports or brew might have the packages you need to run Opportunity.
+
+There is no support for Windows yet.
+
+Then change directory to Opportunity, and use the command make here as well.
+
+This will make an executable for opportunity in the bin folder that you can run from a terminal as usual.
+
+# Features/TODO
+
+- [x] Creation and visualization of Meetups
+- [x] Adding people to meetups
+- [x] Change answers
+- [ ] Edit an Existing Meetup
+- [ ] More security and stability for the software
+- [ ] Full support of a REST API for eventual extern clients
+- [ ] Maybe support another DB