Updated Manual (markdown)

Karmaa
2024-12-10 21:00:57 -06:00
parent 7bf37d1d9b
commit ec3e784cb0

@@ -1 +1,25 @@
In progress...
Required Packages
* NPM
* NodeJS
Download the repo and navigate into the "frontend" directory. Run the following command.
```sh
npm install
```
Then go back to the base directory and go into the backend directory and run the same command.
```sh
npm install
```
Finally, return back to the "frontend" directory and run the following command.
```sh
npm run build
```
to build the project, I recommend running the website via nginx via the nginx config in the docker directory. or
```sh
npm run start
```
to run without building (not recommended). To start the connection websocket, return to the "backend" directory and run the following cmd
```sh
node server.js
```
This will start the websocket on port 8081 (Changes are required to the App.jsx to allow for connection via port instead of appending /ws to the address. This is fixed if you run it via nginx via the nginx.conf in the docker directory.