Skip to content

Commit 077cd2f

Browse files
authored
Merge branch 'develop' into chore/Add-FRONT-env-vars-to-docs
2 parents 8e7a246 + 7b92a7a commit 077cd2f

3 files changed

Lines changed: 422 additions & 418 deletions

File tree

docs/local-development.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,40 @@
44

55
To run Bloom's backend:
66

7-
1. Install prerequisites
8-
2. Configure environment variables
9-
3. Install dependencies
10-
4. Run the app using Docker, Dev Containers, or Manually
11-
5. Populate the database
7+
1. [Install prerequisites](#1-prerequisites)
8+
2. [Configure environment variables](#2-configure-environment-variables)
9+
3. [Install dependencies](#3-install-dependencies-with-yarn)
10+
4. [Run the app using Docker, Dev Containers, or Manually](#4-run-the-app-locally)
11+
5. [Populate the database](#5-populate-the-database-and-database-migrations)
1212

1313
To test the backend:
1414

15-
- Run unit tests
16-
- Run e2e integration tests from the frontend for full-stack contributions
15+
6. [Run unit tests](#6-unit-testing)
16+
7. [Run e2e integration tests from the frontend for full-stack contributions](#7-format-and-linting)
1717

18-
## Prerequisites
18+
- [Git Flow and Deployment](#git-flow-and-deployment)
19+
- [APIs](#apis)
20+
21+
22+
## 1. Prerequisites
1923

2024
- NodeJS v22.x
2125
- Yarn v1.x
2226
- Docker and / or PostgreSQL
2327

2428
_Recommended Minimum System Requirements: CPU: Quad-core 2.5 GHz (i5/Ryzen 5), Memory: 16 GB RAM, Storage: 512 GB, OS: Linux, macOS, Windows, or WSL2 (latest versions), Internet Connection: For accessing dependencies and external APIs/services._
2529

26-
## Configure Environment Variables
30+
## 2. Configure Environment Variables
2731

2832
See [configure-env.md](configure-env.md) for instructions on configuring environment variables.
2933

30-
## Install dependencies with yarn
34+
## 3. Install dependencies with yarn
3135

3236
```bash
3337
yarn
3438
```
3539

36-
## Run the App Locally
40+
## 4. Run the App Locally
3741

3842
There are 3 methods you can use to run Bloom’s backend locally:
3943

@@ -97,7 +101,13 @@ You should see this in the shell output:
97101
Listening on localhost:35001, CTRL+C to stop
98102
```
99103

100-
## Unit Testing
104+
## 5. Populate the Database and Database Migrations
105+
106+
Populating your local database with test data is required for running Cypress integration tests and testing Bloom’s full-stack functionality.
107+
108+
See the [database-guide.md](database-guide.md) for instructions.
109+
110+
## 6. Unit Testing
101111

102112
To run all unit tests
103113

@@ -111,7 +121,7 @@ To have your unit tests running in the background as you change code:
111121
yarn test:watch
112122
```
113123

114-
## Format and Linting
124+
## 7. Format and Linting
115125

116126
Linting and formatting are provided by [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/). We recommend VSCode users to utilize the workspace settings in [.vscode/settings.json](.vscode/settings.json) and install the extensions in [.vscode/extensions](.vscode/extensions.json) for automated consistency.
117127

@@ -135,12 +145,6 @@ Run format and fix:
135145
yarn format
136146
```
137147

138-
# Populate the Database and Database Migrations
139-
140-
Populating your local database with test data is required for running Cypress integration tests and testing Bloom’s full-stack functionality.
141-
142-
See the [database-guide.md](database-guide.md) for instructions.
143-
144148
# Git Flow and Deployment
145149

146150
**The develop branch is our source of truth, not main.** Fork from `develop`, create new feature branch, then when your PR is merged, `develop` will automatically merge into the main branch for deployment to production. Keep your branch updated by rebasing and merging feature/bug branches into `develop` as you code.

package.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,32 +30,32 @@
3030
"dependencies": {
3131
"@mailchimp/mailchimp_marketing": "^3.0.80",
3232
"@nestjs/axios": "^4.0.1",
33-
"@nestjs/common": "^11.1.19",
33+
"@nestjs/common": "^11.1.20",
3434
"@nestjs/config": "^4.0.4",
35-
"@nestjs/core": "^11.1.19",
36-
"@nestjs/platform-express": "^11.1.19",
37-
"@nestjs/platform-socket.io": "^11.1.19",
35+
"@nestjs/core": "^11.1.20",
36+
"@nestjs/platform-express": "^11.1.20",
37+
"@nestjs/platform-socket.io": "^11.1.20",
3838
"@nestjs/schedule": "^6.1.3",
3939
"@nestjs/swagger": "^11.4.2",
4040
"@nestjs/terminus": "^11.1.1",
4141
"@nestjs/throttler": "^6.5.0",
4242
"@nestjs/typeorm": "^11.0.1",
43-
"@storyblok/js": "^5.1.3",
44-
"@nestjs/websockets": "^11.1.19",
43+
"@storyblok/js": "^5.1.5",
44+
"@nestjs/websockets": "^11.1.20",
4545
"axios": "^1.16.0",
4646
"class-transformer": "^0.5.1",
4747
"class-validator": "^0.15.1",
4848
"date-fns": "^4.1.0",
4949
"dompurify": "^3.4.1",
5050
"dotenv": "^17.4.2",
51-
"firebase": "^12.12.1",
52-
"firebase-admin": "^13.8.0",
51+
"firebase": "^12.13.0",
52+
"firebase-admin": "^13.9.0",
5353
"google-auth-library": "^10.6.2",
5454
"jsdom": "^29.1.1",
5555
"lodash": "^4.18.1",
5656
"luxon": "^3.7.2",
5757
"nestjs-cls": "^6.2.0",
58-
"newrelic": "^13.19.2",
58+
"newrelic": "^13.20.0",
5959
"otplib": "^12.0.1",
6060
"pg": "^8.20.0",
6161
"pg-connection-string": "^2.7.0",
@@ -64,7 +64,7 @@
6464
"rollbar": "^3.1.0",
6565
"rxjs": "^7.8.1",
6666
"socket.io": "^4.8.3",
67-
"typeorm": "^0.3.28",
67+
"typeorm": "^0.3.29",
6868
"uuid": "^14.0.0",
6969
"validator": "^13.15.35"
7070
},

0 commit comments

Comments
 (0)