Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,15 @@ jobs:
with:
node-version: "23.5.0"

- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 8

- name: Install dependencies
run: npm ci
run: pnpm install
working-directory: ./server

- name: Test with Jest
run: npm test
run: pnpm test
working-directory: ./server
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@
## Onboarding
### Installing Dependencies
To get started after cloning the repo, first install the necessary dependencies.
The `client` and `server` folders are individual `npm` packages, so you will need to install the respective dependencies separately.
The `client` and `server` folders are individual `pnpm` packages, so you will need to install the respective dependencies separately.
Ensure you have `pnpm` installed. If you don't, follow this [guide](https://pnpm.io/installation).
Run the following commands from the root folder.
```sh
npm ci
pnpm i
cd client
npm ci
pnpm i
cd ../server
npm ci
pnpm i
```
### Connecting To The Database
By this point, you should have recieved an invitation email to the database.
Expand All @@ -46,9 +47,13 @@ You can use an online [uuid generator](https://www.uuidgenerator.net/) to create
### Starting The Development Server
In order to start the frontend development server, run the following command from the `client` directory.
```
npm run dev
pnpm dev
```
This works the same for the backend. Just run the same command from the `server` directory.
If you want to run both at once, navigate to the root directory and run the following command.
```
pnpm start
```
This works the same for the backend. Just run the same command from the `server` directory.

## Documentation Website
We will be using MkDocs for documentation. To run the documentation server, you need to do a few
Expand Down
Loading