github

okTurtles / group-income-simple

  • понедельник, 9 мая 2016 г. в 03:11:22
https://github.com/okTurtles/group-income-simple

JavaScript
Centralized version of Group Income for prototyping and research



Group Income (Simple Edition)

Gitter Build Status Deps Dev Deps

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

Its accounting system can be implemented using a simple Excel spreadsheet, or on blockchains like Ethereum (which is where we're headed). This centralized "Simple Edition" of Group Income is our way to rapidly prototype, develop, and research the concept with real groups.

Installation

npm install -g grunt-cli
npm install

Although it pains us to give up 4-spaced tabs, we're trying out standard for the code style to see how it goes. See also: linting in editors on "save".

js-standard-style

Designers: Read this!

We've put in a lot of energy into taming the craziness of modern web development (where HTML files are shunned and everything involves running crazy command-line tools before you can see the results of your work).

As such, for you we've created a simple-to-follow guide on how to get started designing for this project:

:book: Getting Started

Development

See Getting Started to get setup. The basic grunt workflow commands are listed below:

Run all servers + watch files for changes:

grunt dev

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

Troubleshooting

The recent release of Node 6.0 has caused some problems for some of our dependencies.

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

Contributing

Make sure to work in a named branch. See CONTRIBUTING.md for details.

License

See LICENSE.