Entangler

Entangler is the all-in-one platform for managing requests and item loans.

Note

The backend is no longer being hosted, so the live site will not work as expected.

Docker Quickstart

To start both the frontend and backend, run:

docker compose up -d --build

To stop them, run:

docker compose down

This starts both the frontend and backend together, but they would generally be run separately. For more information, see frontend/README.md and backend/README.md.

Local Quickstart

Backend

To run the backend locally, first navigate to the /backend folder.

To start the backend using npm:

npm install
npm run init
npm start

To start the backend using bun:

bun install
bun run init.ts
bun run index.ts

This will run the API at http://localhost:6231

For more details, visit backend/README.md.

Frontend

To run the frontend locally, first navigate to the /frontend folder.

To start the frontend using npm:

npm install
npm start

To start the frontend using bun:

bun install
bun start

This will host the site at http://localhost:6131 and call the live API (https://quantum-entang.ler.sg). Alternatively, you can run a development server using npm run dev or bun run dev which will call the API locally at http://localhost:6231.

To build the frontend for deployment to static hosting, run:

npm run build

Or bun run build if using bun.

The built site including html, javascript, css and other assets will be found in the /build folder.

For more details, visit frontend/README.md.