Imbus/FrostByte
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Readme update

Browse source
This commit is contained in:
Imbus 2023-10-19 02:42:21 +02:00
parent bd9c228073
commit 368909aefd
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -8,6 +8,7 @@ A simple forum written in Rust and Typescript.
- `server`: Contains the web server code
- `client`: Contains the frontend client
- `client-solid`: Contains the frontend client written in SolidJS (WIP)
## Setup
@ -20,7 +21,7 @@ There are two ways to run this project. The simple way and the manual way.
### 1. The simple way (with aforementioned [Just](https://just.systems/man/en/) and [Podman](https://podman.io/))
To spin up a dev environment, run:
To spin up a dev backend server, run:
``` bash
just dev
@ -32,9 +33,11 @@ For a complete list of targets, run:
just -l
```
Spin up a dev server with `just dev` or just `just`.
This will start a dev server in a container running in the background.
It will also cd into the **client** directory and run `npm run dev` for you. The server will be available at `localhost:8080` and the client (vite preview) will be available at `localhost:3000`.
Spin up a dev server with `just dev` or just `just`.
Keep in mind that this is just the development api server, served on port 8080 by default.
The client is served from the vite dev server as usual at `localhost:3000` by running `npm run dev`.
**Congrats, you're now ready to hack!**
For a project cleanup, you can run `just clean`. This will delete nore_modules and target directories etcetera. It will also stop and remove related images/containers.