come2.help is a project for recruiting and coordinating volunteer people. Possible scenarios are flooding or coordinating support for political refugees.
This is only a REST API for the server. The frontend is not part of this repository. For usage please care about the LICENSE file.
-
Fork the repository for development. Implementations can be submitted by a Pull-Request.
-
Clone the repository to a local directory.
-
Import it to a IDE (e.g. IntelliJ) of your choice (or use vim).
-
Add a local mysql user and database, the default data can be found in application.properties. Do not use this authentication data for production use.
-
First build a jar file, this can be done with:
mvn package
- Execute the binary:
java -jar target/come2help-server-0.0.1-SNAPSHOT.jar
- Execute a request against the REST-API. For example use a REST-Client extension for your browser. For testing you can use the following curl command line:
curl http://localhost:8080/users/1
The result should be the user with the ID 1 (if there is no one, create it with PUT and the URI http://localhost:8080/users. Data can be transmitted as JSON.
Check http://localhost:8080/jsondoc-ui.html and enter "http://localhost:8080/jsondoc" for the json api documentation. It gives an overview over the api. The playground is enabled to submit json objects easily.
mvn clean package -Pdistributablecreates an offline api documentation in target/jsondoc-distribution.zip.
For further contact mail valentin.zickner(at)helfenkannjeder(dot)de, visit http://come2.help/ or create a ticket.