Sign up for Action Beta & be first in line to try it out!
An open-source SaaS application for operating Agile business teams.
by Parabol, Inc
Curious what this is all about? Each week we publish a distillation of our progress, philosophy, and more in Parabol Focus.
Live beta product: http://action.parabol.co/
Action is a Node.js application based upon the Meatier stack:
| Concern | Solution |
|---|---|
| Server | Node 7 |
| Server Framework | Express |
| Database | RethinkDB |
| Data Transport | GraphQL |
| Sockets | socketcluster |
| Client State | Redux |
| Client Data Cache | Cashay |
| Front-end Views | React |
| Styling | aphrodite |
| Unit Testing | jest |
Action is programmed in ECMAscript ES6/7 (including async/await). Transpilation is provided by babel.
Action requires Node.js >=7.6.0 (we're using 7.6.0 in development). We recommend using n to install and manage your node versions.
Action also depends on RethinkDB. Make sure
you have it installed. If you have OSX, we recommend homebrew so
upgrades are as easy as brew update && brew upgrade rethinkdb
Action also uses yarn which can be installed by running npm install -g yarn
$ git clone https://github.com/ParabolInc/action.git
$ cd action
$ rethinkdb # in a separate window
$ yarn
$ npm run quickstartRemember: if RethinkDB is running locally, you can reach its dashboard at http://localhost:8080 by default.
The majority of Action's Javascript files are written using the emerging ECMAScript ES6 and ES7 standards. If you open a source file and see syntax errors, you may have to configure your editor differently. Our team's editors (Atom and Webstorm) have plugins which parse our project's Javascript transpilation options directly from .babelrc. If your editor has this option, it's the best way to go.
In this mode, webpack will hot swap your updated client modules without needing to restarting the development server.
$ npm run build
$ npm run devIn this mode, the server will build client bundle and start a production server with the fresh code.
$ npm run bsThe database schema version is managed by
migrate-rethinkdb.
Migration scripts are stored in ./src/server/database/migrations.
If you make changes to the Action schema, make certain to create a new migration.
$ npm run db:migrate-testing # Only needs to be run once
$ npm run test # Runs all tests$ npm run db:migrateThe following commands are available to migrate your database instance forward and backward in time:
npm run db:migrate-up- migrate up one schema versionnpm run db:migrate-up-all- migrate upward to latest schemanpm run db:migrate-down- migrate down one schema versionnpm run db:migrate-down-all- migrate downward completely (will erase everything)
While running the app in development mode, navigate to http://localhost:3000/graphql for testing out new queries/mutations
We've begun assembling a pattern library of all of the components we've created for the app. Too see them, navigate to http://localhost:3000/patterns
Action is software built with the community for the community. We can't do it without your help!
You're contribution won't go unrewarded: Parabol offers equity in our young company for qualified contributions to Action.
See CONTRIBUTING.md for more information on how to get involved and how to get compensated.
For details on all releases, refer to CHANGELOG.md.
Authored and maintained by Parabol.
Copyright 2016 Parabol, Inc.
Action is dual-licensed under the GNU AFFERO GENERAL PUBLIC LICENSE, Version 3.0 while holding, at its sole discretion, the right to create new licenses. For details please read LICENSE.
See CHANGELOG.md