Skip to content

Commit

Permalink
docs: add basic dev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Thechi2000 committed Sep 11, 2024
1 parent c6a03b8 commit 4458954
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# CLIC x S4S - 2024

## Dev

### Dependencies

You will need the following dependencies:

- [Rust](rustup.rs)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [docker](https://www.docker.com/get-started/)

## Set up environment files

In `app/.env`, put:

```sh
NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000/s4s
NEXT_PUBLIC_API_URL=http://localhost:8000
```

## Run locally

From the `app` directory, run `npm i &&NEXT_PUBLIC_API_URL=http://localhost:8000 npm run dev` in your terminal. In parallel, run `mkdir -p data &&DATA_DIR=$PWD/data cargo r` from the `backend` directory.

Now, you can access the website on <http://localhost:3000/s4s>.

0 comments on commit 4458954

Please sign in to comment.