Skip to content

Commit

Permalink
tweak local development environment guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Dedekind561 committed Apr 9, 2024
1 parent 3ce3b9f commit 678303c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions guides/setup/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ OK

Read this [article on .gitignore](https://sabe.io/blog/git-ignore-node_modules). We have set up a basic `.gitignore` file for you.

## Frontend setup

Since we are using a monorepo, you can launch the frontend the same way you launch the backend. Run the following command in the root of your repo:

```sh
npm run dev
```

The code you put under `client/src` will then be accessible on http://localhost:3000

## Monorepo

The project is set up to run as a monorepo, where both the [`client`](../../client/) and [`server`](../../server/) source code live in the same git repository and are linked together. When using monorepos, there is some boilerplate code required to make sure both the frontend and the backend application can work at the same time and are accessible on the same URL. To kickstart your development we have set up this boilerplate code for you already. Feel free to look at the code, but generally you won't need to edit them if you follow the proposals in this guide.
Expand Down

0 comments on commit 678303c

Please sign in to comment.