About

Group Income is voluntary, decentralized, end-to-end encrypted basic income for you and your friends.

Getting Started

1. Install Node.js (v20 minimum required)
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
5. Run ./node_modules/.bin/chel init. This generates a chel.toml config file in the project root (required).
6. Now try out the dev workflow.

• 👩‍🎨 Check out how Group Income will feel like by taking a look at the design files on Figma

Contributing

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

We are continually improving the user experience for everyone, and applying the relevant accessibility standards. We will be conformant with WCAG 2.0 Level AA and trying our best to reach Level AAA in some areas of the application.

Read first

• __:book: CONTRIBUTING.md (required reading to send a PR!)__
• :book: Getting Started — Modern frontend concepts & project overview
• :book: Style Guide — Our development guidelines
• :book: Information Flow - walkthrough of the logical layer

Basic workflow

To get started with development, follow the steps in Getting Started first.

Run all servers + watch files for changes

grunt dev

• If all went well you should be able to visit http://localhost:3000

Try ngrok (recommended), zrok, tunnl.gg, localhost.run or serveo instead, e.g.:

$ grunt dev
then, in another terminal:
$ ngrok http http://localhost:8000
or:
$ ssh -R 80:localhost:8000 [email protected]

Clean up files in dist/:

grunt clean

Run tests:

NOTE: You may need to first install Cypress using ./node_modules/.bin/cypress install

# all tests
grunt test
all tests while skipping build step
grunt test --skipbuild
unit tests only (always skips build)
grunt test:unit
show e2e tests (Cypress) live in a browser
grunt test --browser
run e2e tests (Cypress) in "open" mode
grunt test --browser=debug
Developing at the same time as writing E2E tests
grunt dev
and in another terminal run Cypress in "open" mode
npm run cy:open
Run a specific Cypress spec against the running 'grunt dev' server:
npx cypress run -c 'baseUrl=http://localhost:8000' --spec "test/cypress/integration/group-chat.spec.js"

This project is tested with BrowserStack.

Using Docker for extra security

You can run commands in a Docker container by using npm run docker -- instead.

For example:

npm run docker -- npm install
npm run docker -- grunt dev
npm run docker -- grunt test --skipbuild

For details, see: Docker.md

Troubleshooting

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

Try also:

$ npm version --no-git-tag-version 2.9.0

$ git diff --name-only v2.8.0 master -- frontend/model/contracts

# Print usage (also shows current vs. target appVersion):
$ grunt pin
Copy the version to chelonia.json and pin every contract:
$ NODE_ENV=production grunt pin --all
Copy the version only (app update with no contract changes):
$ NODE_ENV=production grunt pin --none
Copy the version and pin only the named contract:
$ NODE_ENV=production grunt pin:chatroom

$ git add package.json package-lock.json chelonia.json contracts/
$ git commit -m "v2.9.0"

$ git tag -u '<email>' v2.9.0  # create the tag before calling grunt deploy
$ ./scripts/dist.sh

Donations to the okTurtles Foundation support the development of Group Income and related projects.

License

AGPL-3.0. See LICENSE for license details and CONTRIBUTING.md for the contribution policy.