Action

Overview

Parabol is a free open-source SaaS application for running team retrospectives and operating a distributed organization.

We're hiring!

Curious to learn where this all came from? Each week we publish a distillation of our progress, philosophy, and more in Parabol Focus.

Quick Links

Stack Information
Setup
Getting Involved
Releases
About
License

Stack Information

Action is a Node.js application based upon the Meatier stack:

Concern	Solution
Server	Node
Server Framework	Express
Database	RethinkDB
PubSub	Redis
Data Transport	GraphQL
BidirectionalTransport (WebSocket, SSE, WebRTC, ec)	trebuchet
Client Cache	Relay
UI Framework	React
Styling	Emotion
Unit Testing	jest
Integration Testing	Cypress

Setup

Installation

Prerequisites

Node v11+
RethinkDB
Redis
yarn
watchman (for Relay)

Source code

$ git clone https://github.com/ParabolInc/action.git
$ cd action
$ cp packages/server/.env.example packages/server/.env # Add your own vars here
$ rethinkdb &
$ yarn
$ yarn quickstart

Remember: if RethinkDB is running locally, you can reach its dashboard at http://localhost:8080 by default.

Development

$ yarn dev

Database Migration

$ npm run db:migrate

The database schema version is managed by migrate-rethinkdb. Migration scripts are stored in ./packages/server/database/migrations.

Getting Involved

Parabol offers equity for qualified contributions.

See CONTRIBUTING.md for more information on how to get involved and how to get compensated.

Releases

For details on all releases, refer to CHANGELOG.md.

About

Authored and maintained by Parabol.

Parabol Core Team

License

This codebase is dual-licensed under the GNU AFFERO GENERAL PUBLIC LICENSE, Version 3.0 while holding, at Parabol's sole discretion, the right to create new licenses. For details please read LICENSE.

andrewpaulino/parabol