From 874bff6051475560d55d02b5e467371f12bb2aee Mon Sep 17 00:00:00 2001 From: Karmaa <88517757+LukeGus@users.noreply.github.com> Date: Thu, 6 Mar 2025 19:52:31 -0600 Subject: [PATCH] Updated Manual (markdown) --- Manual.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/Manual.md b/Manual.md index bf538b3..d7ef11d 100644 --- a/Manual.md +++ b/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. \ No newline at end of file +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. \ No newline at end of file