Quick Start

For an overview of this repository, please see the wiki

System Prerequisites

• Docker (if not using Docker, you will need Node LTS 14.7.x and Postgres 13.x)
• (Optional, highly recommended) - Install the NX Console for using the nx client

Run the app locally

Setup ENV

cp .env.example .env

A working local development .env file can be found in 1Password under the "Engineering" folder.

With Docker (preferred)

Start server and client apps

yarn install
yarn dev

Migrate DB

In a separate terminal, run the following command. This will connect to the Postgres DB running inside Docker and run all the migrations in /prisma/migrations.

yarn prisma:migrate

You will also want to seed the database (includes account types and subtypes for categorization).

yarn prisma:seed

Manually

NOTE: Make sure Postgres 13.x is running on your machine

yarn install
nx serve client # Terminal 1
nx serve server # Terminal 2
yarn prisma:migrate && yarn prisma:seed # Terminal 3 - after apps are running

Reference

Deployments and CI/CD

See this wiki page for an overview of how deployments work.

Authentication

See this wiki page for an explanation of how authentication/authorization works in this codebase.

BullMQ Message Queue

See this wiki page for an overview of BullMQ and how it is used within the repo.

Feature Flags

See this wiki page for an overview of how we use feature flags.

Testing Intercom Locally

yarn dev:services:all
yarn dev
ngrok http --region=us --hostname=localhost.maybe.co 4200

Visit https://localhost.maybe.co