dennii/Termix
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases 22 Wiki Activity

Updated Manual (markdown)

Karmaa
2025-03-06 19:52:31 -06:00
parent ec3e784cb0
commit 874bff6051
1 changed files with 4 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Manual.md

@@ -2,24 +2,17 @@ Required Packages
* NPM
* NodeJS
Download the repo and navigate into the "frontend" directory. Run the following command.
Clone the repo then run the following commands.
```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
to run without building (not recommended). To start the connection websocket, go to the "src/backend" directory and run the following cmd
```sh
node server.js
node server.cjs
```
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.
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.