Clone
13
Manual
Karmaa edited this page 2025-06-19 00:17:09 -05:00

Required Packages

  • NPM
  • NodeJS

Clone the repo then run the following commands:

npm install
npm run build

to build the project, I recommend hosting the website via nginx via the nginx config in the docker directory. or:

npm run dev

to run without building (not recommended). To start the connection websocket, go to the src/backend directory and run the following command:

node starter.cjs

This will start the file and database API on ports 8081 and 8082. The website itself should be accessible via http://localhost:8080 if using nginx, if using npm run dev, it will be http://localhost:5173.