Parabol - We’re hiring!

Overview

Parabol is an open-source application for running
agile meetings such as team retrospectives or Sprint Poker™. You may try
a single-player demo of Parabol (no login creation required) at: https://parabol.co/retro-demo

We endeavor to be a
transparent organization and publish
our company’s history and SaaS metrics.

Stack Information

Concern	Solution
Server	Node
Server Framework	μWebSockets.js
Database	PostgreSQL
PubSub & Cache	Redis
Data Transport	GraphQL
Real-time Connectivity	trebuchet
Client Cache	Relay
UI Framework	React
Styling (Legacy)	Emotion
Styling	Tailwind CSS

Setup

Prerequisites

• Node
• Yarn
• Docker Compose
• Watchman (Development only)

Installation

$ git clone https://github.com/ParabolInc/parabol.git
$ cd parabol
$ cp .env.example .env # Add your own vars here
$ yarn
$ yarn db:start
$ yarn dev

• By default, the app will run at: http://localhost:3000/

• If yarn db:start failed and localhost:5050 isn’t working, a docker
  container, volume, or image may be corrupted and need to be pruned.

Development

• Code Reviews
• Create new GraphQL Mutations
• Docker
• Dev.js
• File Storage (CDN, Local, S3)
• GraphiQL, Private Schema Admin
• GraphQL Executor
• Integrations (GitHub, Jira, Slack, etc.)
• PostgreSQL
• Shared Scripts
• VS Code Tips
• Tailwind CSS migration guide

Deploy

$ yarn && yarn pg:build && yarn build && yarn predeploy && yarn start

• How to Ship

Getting Involved

Parabol offers equity for qualified contributions.

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

Have feedback, ideas or feature requests?

Please review our Discussions to see if there’s already a similar suggestion, and if not please feel free to start a new one.

Releases

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

Parabol Core Team

• Jordan Husney
• Terry Acker
• Matt Krick

Parabol Maintainers

• Matt Krick
• Georg Bremer

License

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