Group Income (Simple Edition)

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.

Installation

1. Install Node.js (version 8 or greater).
2. Install Grunt: npm install -g grunt-cli
3. Clone this repo (or a fork of it if you plan on contributing) and cd into it.
4. Install dependencies: npm install

Now try out the dev workflow.

---

We use standard for the code style and mileposts for efficient project management.

 

Contributing

Read first!

• 📖 CONTRIBUTING.md (required reading to send a PR!)
• 📖 Getting Started — Modern frontend concepts & project overview

Basic workflow

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!

Using Docker for extra security

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

Troubleshooting

If you run into any errors during the setup, try the suggestions in Troubleshooting.md.

License

GPLv3. See LICENSE for license details and CONTRIBUTING.md for contributing policy.