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 Web-App. The REST API 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).
-
If you want to use the backend, also install come2help-server. See the tutorial in come2help-server.
-
Install all dependencies:
npm install
- Start the development services:
npm startThis will start:
- A watch to build all files that need to be built.
- A webserver
- A LiveReload server
-
Run
localhost:8000in a browser of your choice. Install LiveReload to have it automatically updated. -
Start coding!
Tests are run through npm:
npm test
Runs the behaviour test in Firefox. Requires firefox to be installed.
npm run chrometest -s
Runs the behaviour test in Chrome. Requires chrome to be installed.
npm run browsertest -s
Runs the behaviour test in multiple browsers on BrowserStack. You'll need to provide BrowserStack credentials, either in the environment variables BROWSERSTACK_USER and BROWSERSTACK_KEY, or in test/behaviour/.browserstackrc in the form of module.exports = {key: YOUR_KEY, user: YOUR_USERNAME}.
npm run lint -s
Lints the code.