Skip to content
Free online agile retrospective meeting tool
TypeScript JavaScript Other
Branch: master
Clone or download

README.md

Parabol - We're hiring!

Slack Status CircleCI StackShare

Overview

Parabol is a free SaaS application for running team retrospectives and operating a distributed organization. Our business metrics are also open source.

Dashboard Discuss

Stack Information

Concern Solution
Server Node
Server Framework uWebSockts.js
Database RethinkDB
PubSub Redis
Data Transport GraphQL
Real-time Connectivity trebuchet
Client Cache Relay
UI Framework React
Styling Emotion
Unit Testing jest
Integration Testing Cypress

Setup

Prerequisites

  • Node
  • Redis
  • RethinkDB
  • Watchman (for Relay)
  • Yarn

Installation

$ git clone https://github.com/ParabolInc/parabol.git
$ cd parabol
$ cp packages/server/.env.example packages/server/.env # Add your own vars here
$ rethinkdb & # Or if you prefer docker: $ docker-compose up -d db
$ yarn && yarn db:migrate && yarn build:relay && yarn dev

Database

  • Migrations are stored in packages/server/database/migrations
  • RethinkDB Dashboard is at http://localhost:8080

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.

Parabol Core Team

License

Copyright (c) 2016-present, Parabol, Inc.

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.

You can’t perform that action at this time.