Group Income is a fair income sharing mechanism that allows groups to provide their members a minimum income.
This semi-centralized "Simple Edition" of Group Income is our way to rapidly prototype, develop, and research the concept with real groups.
- Install Node.js (version 8 or greater).
- Install Grunt:
npm install -g grunt-cli - Clone this repo (or a fork of it if you plan on contributing) and
cdinto it. - Install dependencies:
npm install
Now try out the dev workflow.
We use standard for the code style and Github project boards for efficient project management.
- 📖 CONTRIBUTING.md (required reading to send a PR!)
- 📖 Getting Started — Modern frontend concepts & project overview
Run all servers + watch files for changes:
grunt dev
- After running
grunt dev, visit the website: http://localhost:8000
Build the app for distribution:
grunt dist
Clean up files in dist/ and the sqlite.db file (which will be better handled in the future):
grunt clean
Run the tests:
grunt test
Use Daydream to create frontend tests. All new functionality must have corresponding tests!
You can run commands in a Docker container by using npm run docker -- <cmd> instead.
For example:
$ npm run docker -- npm install
$ npm run docker -- grunt dev
For details, see: Docker.md
If you run into any errors during the setup, try the suggestions in Troubleshooting.md.
Donations to the okTurtles Foundation support the development of Group Income and related projects.
GPLv3. See LICENSE for license details and CONTRIBUTING.md for contributing policy.