Skip to content

okTurtles/group-income

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Group Income (Simple Edition)

About

Group Income is a fair income sharing mechanism that allows groups to provide their members a minimum income.

Getting Started

  1. Install Node.js
  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. Now try out the dev workflow.

Contributing

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

js-standard-style

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.

Level Double-A conformance, W3C WAI Web Content Accessibility Guidelines 2.0

Read first

Bounties

Some issues have bounties assigned to them.

  • Anyone can post a bounty by donating to this project and letting us know which issue you'd like the bounty to be applied to.
  • Non-contractors can receive bounties by submitting PRs for them. If we approve and merge the PR, you get the bounty!
  • If there's an issue you'd like okTurtles to prioritize by posting a bounty to it, feel free to let us know via Gitter or Slack!

Any open contractor positions are posted to: Open Positions

Basic workflow

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

Run all servers + watch files for changes

grunt dev

Create a tunnel to share access over the Internet:

grunt dev --tunnel

Build the app for distribution

grunt dist

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

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
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.

Donating

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.

About

Voluntary Basic Income system that's decentralized and end-to-end encrypted.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages