Skip to content

docs: clarify first time dev setup #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SuperVK wants to merge 1 commit into
base: develop
Choose a base branch
from
+6 −1
Open

docs: clarify first time dev setup #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ the client can make HTTP calls to the core to request this data.
## Prerequisites
- NodeJS 22.
- A locally running copy of [aurora-core](https://github.com/gewis/narrowcasting-core).
The client repository should be cloned next to the core repository, so in the folder `../aurora-core`.
The backoffice repository should be cloned next to the core repository, like the following:
```
parent-dir/
├── aurora-core/
└── aurora-client/
```
This is necessary to generate the required API client files (installation step 2).

## Installation
Expand Down