Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lameuler/entangler
https://github.com/lameuler/entangler
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lameuler/entangler
- Owner: lameuler
- Created: 2024-03-02T07:15:58.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-03T11:55:11.000Z (6 months ago)
- Last Synced: 2024-06-03T13:54:58.246Z (6 months ago)
- Language: Svelte
- Size: 510 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```sh
docker compose up -d --build
```
To stop them, run:
```sh
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](frontend/README.md) and [backend/README.md](backend/README.md).
## Local Quickstart
### Backend
To run the backend locally, first navigate to the `/backend` folder.
To start the backend using `npm`:
```sh
npm install
npm run init
npm start
```
To start the backend using `bun`:
```sh
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](backend/README.md).
### Frontend
To run the frontend locally, first navigate to the `/frontend` folder.
To start the frontend using `npm`:
```sh
npm install
npm start
```
To start the frontend using `bun`:
```sh
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:
```sh
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](frontend/README.md).