Skip to content

Commit 391ff0f

Browse files
committed
chore: update contributing guidelines and package.json scripts for improved clarity and development workflow
1 parent 36e1773 commit 391ff0f

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ We provide a `docker-compose-dev.yml` file that sets up:
3131
To start the services, run the following in the root directory:
3232

3333
```bash
34-
docker-compose -f docker-compose-dev.yml up -d
34+
docker-compose -f docker-compose.yml up -d
3535
```
3636

3737
> Remove the `-d` flag if you'd like to see container logs in your terminal.
3838
39-
You can find authentication details in the [`docker-compose-dev.yml`](docker-compose-dev.yml) file.
39+
You can find authentication details in the [`docker-compose.yml`](docker-compose.yml) file.
4040

4141
---
4242

@@ -160,12 +160,10 @@ curl -X 'GET' \
160160
161161
## Running Tests
162162

163-
Currently, tests are available for the `server` and `shared` packages.
163+
Currently, tests are available for the `backend`and some packages in the `packages` directory.
164164

165-
We use [Jest](https://jestjs.io/) for testing. To run tests:
165+
We use bun's built-in test runner for testing. To run tests:
166166

167167
```bash
168168
bun run test
169169
```
170-
171-
Run this inside the package directory you want to test.

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@
4242
"start:server": "cd ./apps/backend && bun run start",
4343
"start:server:prod": "cd ./apps/backend && bun run start",
4444
"start:web:prod": "cd ./apps/frontend && bun run start",
45-
"dev": "concurrently --success first -n \"server,web,database,song,sounds,thumbnail,components\" --prefix-colors \"cyan,magenta,blue,green,yellow,red,white\" --prefix \"{name} {time}\" \"bun run start:server\" \"cd ./apps/frontend && bun run start\"",
45+
"dev": "concurrently --success first -n \"server,web\" --prefix-colors \"cyan,magenta\" --prefix \"{name} {time}\" \"cd ./apps/backend && bun run start:dev\" \"cd ./apps/frontend && bun run start\"",
46+
"dev:server": "cd ./apps/backend && bun run start:dev",
47+
"dev:web": "cd ./apps/frontend && bun run start",
4648
"lint": "eslint \"**/*.{ts,tsx}\" --fix --max-warnings 20",
4749
"lint:server": "cd ./apps/backend && eslint \"src/**/*.ts\" --ignore-pattern \"**/*.spec.ts\" --ignore-pattern \"**/*.test.ts\" --fix --max-warnings 10",
4850
"lint:web": "cd ./apps/frontend && eslint \"src/**/*.{ts,tsx}\" --fix --max-warnings 10",

0 commit comments

Comments
 (0)