Welcome to Bloom

Currently in active development.

Bloom is a remote trauma support service from Chayn, a global charity supporting survivors of abuse across borders. Bloom is our flagship product; a free, web-based support service designed for anyone who has experienced or is currently experiencing domestic or sexual abuse. Through a combination of online video-based courses, anonymous interaction and 1:1 chat, Bloom aims to provide tailored information, guidance, everyday tools, and comforting words to cope with traumatic events. 💖

Get Involved

Do you want to make an impact with Chayn and receive special access to our organization and volunteer opportunities? Please visit our Getting Involved Guide to get started!

Other ways you can support Chayn are donating, starring this repository ⭐ (so we can find more contributors like you!), making an open-source contribution, and supporting us on social media!

Find us online:

• Website: https://www.chayn.co/
• Linktree: https://linktr.ee/chayn
• Twitter: @ChaynHQ
• Instagram: @chaynhq
• Youtube: Chayn Team
• LinkedIn: @chayn

Contributing to Bloom Backend

Before making a contribution, please read our Contributing Guidelines in the CONTRIBUTING.md file.

We ask all contributors to follow our Contributing Guidelines to help Chayn developers maintain open-source best practices.

Happy coding! ⭐

Technologies Used:

For a more detailed explanation of this project's key concepts and architecture, please visit the /docs directory.

• NestJS - NodeJs framework for building scalable and reliable server-side applications
• PostgreSQL - Object-relational SQL database system
• TypeORM - Object Relational Mapper library
• Firebase - User authentication
• Storyblok - Headless CMS for pages and courses content
• Simplybook - Appointment booking system used for therapy
• Slack - Slack webhooks to send messages to the team
• Rollbar - Error reporting
• Crisp - User messaging
• Docker - Containers for api and db
• Heroku - Build, deploy and operate staging and production apps
• GitHub Actions - CI pipeline
• Swagger - API documentation

Local development

Prerequisites

• NodeJS v20.x
• Yarn v1.x
• Docker

Run in Dev Container - OPTIONAL

Recommended for Visual Studio & Visual Studio Code users.

This method will automatically install all dependencies and IDE settings in a Dev Container (Docker container) within Visual Studio Code. Simply clone this repo to your computer, open in Visual Studio Code, and select "Re-open in Container" when notified.

After re-opening VS Code in a dev container, develop as you normally would and use the container terminal within VS Code. Next, configure your environment variables.

The dev Container is configured in the .devcontainer directory:

• docker-compose.yml file in this directory extends the docker-compose.yml in the root directory.
• devcontainer.json configures the integrations with Visual Studio Code, such as the IDE extensions and settings in the vscode directory.

Read for more detailed instructions: Visual Studio Code Docs: Developing Inside a Dev Container.

Install dependencies

yarn

Configure Environment Variables

• If you are an official Chayn volunteer: please get in touch with the team for access to our environment variables.

• If you are an open-source contributor: create a new .env file and populate it with the following variables.

The Firebase tokens are required for running locally, the Simplybook tokens are required for testing, and all other variables are optional.

You will need to gather your own Firebase tokens. Here are resources to get started:

• Firebase Docs: Auth
• Firebase Docs: API Keys
• Firebase Docs: Projects
• Firebase Docs: Get Started with Fundamentals

The Simplybook variables can be mocked data, meaning you do not need to use real Simplybook variables, simply copy paste the values given below. If you acquire real Simplybook environment variables, use the same format given below.

ROLLBAR_ENV=development
PORT=35001

DATABASE_URL=postgres://<username>:<password>@<host>:<port>/<db>

NODE_ENV=development

FIREBASE_TYPE=service_account
FIREBASE_PROJECT_ID=
FIREBASE_PRIVATE_KEY_ID=
FIREBASE_PRIVATE_KEY=
FIREBASE_CLIENT_EMAIL=
FIREBASE_CLIENT_ID=
FIREBASE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
FIREBASE_TOKEN_URI=https://oauth2.googleapis.com/token
FIREBASE_CERT_URL=https://www.googleapis.com/oauth2/v1/certs
FIREBASE_CLIENT_CERT=

FIREBASE_API_KEY=
FIREBASE_AUTH_DOMAIN=
FIREBASE_PROJECT_ID=
FIREBASE_STORAGE_BUCKET=
FIREBASE_MESSAGING_SENDER_ID=
FIREBASE_API_ID=
FIREBASE_MEASUREMENT_ID=

# VARIABLES REQUIRED FOR TESTING, REPLACE WITH REAL VALUES IF NEEDED
SIMPLYBOOK_CREDENTIALS='{"login":"testlogin","password":"testpassword","company":"testcompany"}'
SIMPLYBOOK_COMPANY_NAME=testcompany

# VARIABLES BELOW ARE ALL OPTIONAL
ROLLBAR_TOKEN=
ZAPIER_TOKEN=
SLACK_WEBHOOK_URL=
CRISP_TOKEN=
CRISP_WEBSITE_TOKEN=
MAILCHIMP_MANDRILL_API_KEY=
MAILCHIMP_THERAPY_TEMPLATE_ID=
MAILCHIMP_THERAPY_FROM_EMAIL=
RESPOND_IO_CREATE_CONTACT_WEBHOOK=
RESPOND_IO_DELETE_CONTACT_WEBHOOK=

Run the App Locally

Using Docker - RECOMMENDED

The project is containerized and can be run solely in docker - both the PostgreSQL database and NestJS app. To run the backend locally, make sure your system has Docker installed - you may need Docker Desktop if using a Mac.

First make sure the docker app is running (just open the app). Then run

docker-compose up

You should see this in the shell output:

Listening on localhost:35001, CTRL+C to stop

Note: you can use an application like Postman to test the apis locally

Without Docker

First install postgres. Next follow directions to seed the database, then run:

yarn start:dev

You should see this in the shell output:

Listening on localhost:35001, CTRL+C to stop

Database migrations

A migration in TypeORM is a single file with SQL queries to update a database schema as updates/additions are made. Read more about migrations here.

Migrations are automatically run when the app is built docker (locally) or Heroku for staging and production apps.

You'll need to generate and run a migration each time you add or update a database field or table.

To generate a new migration

yarn migration:generate

To run (apply) migrations

yarn migration:run

To revert a migration

yarn migration:revert

Note that when running the app in Docker, you may need to run migration commands from the docker terminal/Exec

New environment variables must be added to Heroku before release.

Run unit tests

To run all unit tests

yarn test

To have your unit tests running in the background as you change code:

yarn test:watch

Formatting and linting

To run linting

yarn lint

To lint and fix

yarn lint:fix

Formatting and linting is provided by ESLint and Prettier (see the relevant configs for details).

Workspace settings for VSCode are included for consistent linting and formatting.

Seed Local Database

If you're a volunteer, add data to your local database by seeding it with a backup file. Please read our Tech Volunteer Guide for directions on seeding the local database.

If you're staff and have access to Heroku, you also have the option to seed the database via the following script. Before you start, make sure:

1. bloom-local-db container is running in Docker
2. you are logged into the Heroku via your terminal. Read more about the Heroku Cli here
3. Replace <HEROKU_APP_NAME> with the correct Heroku app name in the seed-local-db.sh file
4. Run chmod +x ./seed-local-db.sh in your terminal to make the file executable

After the above has been confirmed, run

bash seed-local-db.sh

Git Flow and Deployment

The develop branch is our source of truth, not main.

Create new branches from the develop base branch. There is no need to run the build command before pushing changes to GitHub, simply push and create a pull request for the new branch. GitHub Actions will run build and linting tasks automatically. Rebase and merge feature/bug branches into develop.

This will trigger an automatic deployment to the staging app by Heroku.

When changes have been tested in staging, merge develop into main. This will trigger an automatic deployment to the production app by Heroku.

Swagger

Swagger automatically reflects all of the endpoints in the app, showing their urls and example request and response objects.

To access Swagger simply run the project and visit http://localhost:35001/swagger

License

Bloom and all of Chayn's projects are open source. The core tech stack included here is open source however some external integrations used in the project require subscriptions.