autobaan/README.md
collin 468f22f3e9
All checks were successful
ci/woodpecker/push/test Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
Adding status badge from woodpecker to README
2026-03-24 17:03:31 +01:00

38 lines
734 B
Markdown

# autobaan
![alt text](https://woody.collinduncan.com/api/badges/1/status.svg)
Automatic court reservation!
## Setup
### Requirements
- Node.js (18.x)
- npm (8.x)
- nvm
- Docker
- redis
#### Using nvm
1. Install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
1. `nvm use` will use version specified in `.nvmrc`
1. `nvm install-latest-npm` will upgrade NPM to latest version (8.x)
### Usage
```bash
npm install
npm start:dev
```
## Deployment
- Create a volume which will store the SQLite database file using docker-like
- Build image via provided dockerfile
- Run container with built image exposing port 3000 and mapping the aforementioned volume to /app/db
### CD
Using woodpecker to deploy this via pm2.