search

chaynHQ / bloom-frontend

Code for the for the frontend of the Bloom service.
https://bloom.chayn.co/
MIT License
28 stars 45 forks source link
hacktoberfest nextjs opensourceforgood public-goods react sdg-5 typescript

readme

Welcome to Bloom

Bloom CI Pipeline

Bloom is a remote trauma support service from Chayn, a global, award-winning charity designing open-source tools to support the healing of survivors across the world. Since 2013, Chayn has reached over 500,000 survivors worldwide with our trauma-informed, survivor-centred, and intersectional approaches in utilizing tech for social impact. Bloom is our flagship product; a free, web-based, secure support service designed to aid in the healing of survivors. Through a combination of online video-based courses, anonymous interaction, and 1:1 chat, Bloom provides tailored information, self-help guidance, everyday tools, and comfort to cope with traumatic events.

Explore Chayn's website, research, resources, projects, impact, and support services directory. 💖

Support Our Work

Chayn is proudly open-source and built with volunteer contributions. We are grateful for the generosity of the open-source community and aim to provide a fulfilling experience for open-source developers.

Please give this repository a star ⭐ and follow our GitHub profile 🙏 to help us grow our open-source community and find more contributors like you!

Support our mission further by sponsoring us on GitHub, exploring our volunteer programs, and following Chayn on social media: - Linktree: https://linktr.ee/chayn - Twitter: @chaynhq - Instagram: @chaynhq - Youtube: @chaynhq - Facebook: @chayn - LinkedIn: @chayn.

Bloom Frontend Contribution Docs:

By making an open-source contribution to Chayn, you have agreed to our Code of Conduct.

Happy coding! ⭐

Technologies Used

Visit the /docs directory for an overview of Bloom's frontend key concepts.

Local Development:

Summary

To run Bloom's frontend: install prerequisites, run Bloom's backend locally, configure environment variables, install dependencies, then run the app locally with yarn.

Before running Cypress integration tests, first populate your backend local database with test data (directions in Bloom's backend repo).

Prerequisites

Run Local Backend

See Bloom's backend repo for instructions. You will need to run this in the background for the frontend to be functional.

Configure Environment Variables

Create a new .env.local file and fill it with the required environment variables:

# Variables for building, unit tests, and integration tests.
# Provided variables are read-only and subject to change.
#====================================================================
# REQUIRED VARIABLES FOR LOCAL DEVELOPMENT
#--------------------------------------------------------------------
# CORE ENVIRONMENT VARIABLES
NEXT_PUBLIC_ENV=local
NEXT_PUBLIC_API_URL=http://localhost:35001/api/v1
NEXT_PUBLIC_BASE_URL=http://localhost:3000
NEXT_PUBLIC_PORT=3000

# FIREBASE AUTH AND ANALYTICS
NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=

# CONTENT TOKEN
NEXT_PUBLIC_STORYBLOK_TOKEN=xB5HoaLRkYs8ySylSUnZjQtt

# FEATURE FLAGS
NEXT_PUBLIC_FF_USER_RESEARCH_BANNER=true

# REQUIRED VARIABLES FOR CYPRESS INTEGRATION TESTING
# SEE CYPRESS.MD FOR INSTRUCTIONS
#--------------------------------------------------------------------
# CYPRESS PROJECT
CYPRESS_PROJECT_ID=

# MAILSLURP
CYPRESS_MAIL_SLURP_API_KEY=
CYPRESS_INBOX_ID=

# LOCAL BLOOM USERS
CYPRESS_SUPER_ADMIN_EMAIL=
CYPRESS_SUPER_ADMIN_PASSWORD=
CYPRESS_PUBLIC_NAME=
CYPRESS_PUBLIC_EMAIL=
CYPRESS_PUBLIC_PASSWORD=
CYPRESS_BUMBLE_PARTNER_ADMIN_EMAIL=
CYPRESS_BUMBLE_PARTNER_ADMIN_PASSWORD=
CYPRESS_BADOO_PARTNER_ADMIN_EMAIL=
CYPRESS_BADOO_PARTNER_ADMIN_PASSWORD=

# OPTIONAL VARIABLES
#--------------------------------------------------------------------
# NEW RELIC TRACKING
NEW_RELIC_LICENSE_KEY=eu01xx6fc63a14eea79c367dfe82e702FFFFNRAL
NEW_RELIC_APP_NAME=bloom-frontend
NEW_RELIC_BROWSER_MONITORING_KEY=NRJS-0f9d5f21ee9234a45cc

# ANALYTICS
NEXT_PUBLIC_HOTJAR_ID=
NEXT_PUBLIC_GOOGLE_TAG_MANAGER_ID=

# ADDITIONAL FEATURES
NEXT_PUBLIC_CRISP_WEBSITE_ID= # User messaging
NEXT_PUBLIC_SIMPLYBOOK_WIDGET_URL= # Booking session forms
NEXT_PUBLIC_ZAPIER_WEBHOOK_DEMO_FORM= # User data form webhooks
NEXT_PUBLIC_ZAPIER_WEBHOOK_SETA_FORM= # User data form webhooks
NEXT_PUBLIC_ROLLBAR_ENV= # Rollbar logging
NEXT_PUBLIC_ROLLBAR_TOKEN= # Rollbar logging

How to Configure Firebase Variables:

To configure the Firebase variables, create a Firebase project in the Firebase console (Google account required). For additional guidance on setting environment variables, check out our Chayn Tech Wiki Guide.

How to Create New Environment Variables:

If creating new environment variables, please tag Chayn staff developers in PR / issue discussions to let us know. New environment variables may require being added to Vercel (required for production-level variables) and GitHub Actions (required for app to build and pass CI tests). Note: Environment variables that are exposed to the client/browser must be prefixed with NEXT_PUBLIC_ - see next.js docs.

Additional Helper Environment Variables (optional):

How to Import Environment Variables with Vercel (Chayn team only):

Install Dependencies

Install dependencies by running:

yarn

Run Locally with yarn

Start the app in development mode (with hot-code reloading, error reporting, etc.):

yarn dev

Go to http://localhost:3000

Unit Testing

yarn test

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

yarn test:watch

Format and Linting

Linting and formatting are provided by ESLint and Prettier. We recommend VSCode users to utilize the workspace settings in .vscode/settings.json and install the extensions in .vscode/extensions for automated consistency.

Additionally, this application uses Pre-commit and husky to run formatting and linting before each commit is pushed. If an error is thrown when pushing a commit:

We strongly recommend maintaining consistent code style by linting and formatting before every commit:

Run linting:

yarn lint

Run lint and fix:

yarn lint:fix

Run format and fix:

yarn format

Build for Production

For testing the production build. This will be run automatically during deployments.

yarn build

Cypress Testing

Bloom uses Cypress to perform end-to-end (e2e) tests of platform. See CYPRESS.md for set-up instructions.

Git Flow and Deployment

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

Staging Directions for Contributors

Testing the staging preview is helpful for making front-end design changes.

  1. Creating a pull request will trigger GitHub Actions to automatically run build and linting tasks. A vercel preview url will also be created, to act as a staging environment for this branch
  2. Test the new branch on the vercel preview url, and ensure all new changes working as expected
  3. Request a code review from a staff member who will manage the merge and deployment flow.

Staging Merge and Deployment Flow Directions for Maintainers

  1. When a pull request is approved, squash and merge the pull request into develop. Merging a pull request into develop will trigger a deployment to the staging preview url. A new pull request Merge Develop onto Main will be automatically created when develop is ahead of main

  2. This new Merge Develop onto Main pull request will be aligned to the staging preview url and should be retested where multiple changes have been made - this may not be required where changes are unrelated and were all tested individually

  3. When changes are ready to be released to production, merge the new Merge Develop onto Main pull request. This will merge develop into main and trigger an automatic deployment to production via the Github <-> Vercel integration which aligns to the main branch

Using the Staging and Preview URLSs:

Using the preview urls means that your usage/testing doesn’t impact our metrics. For example, if you signed up for a new account for testing on the live site, then we would count that as one more user who signed up. To prevent testing data mixing with user data, the preview urls usage data is not tracked.

You should be using the preview urls whenever possible.

To use the preview urls, navigate to them and click 'Get Started' in the homepage to create a new account with any email and password.

If you already have an account, please login using the email and password you already set. If it says your account it already registered and you can’t remember the password, use the password reset flow. If you want to create multiple accounts, you can add a +1 to your email like <hello+1>@chayn.co and it will treat it as a new email address (but the emails still go to your inbox, magic ✨)

Our preview urls work almost exactly like our live website, except for:

You might want to use the live site if:

License

This project uses the MIT License.

Bloom and all of Chayn's projects are open-source.

While the core tech stack included here is open-source, some external integrations used in this project require subscriptions.