autobaan/README.md

39 lines
734 B
Markdown
Raw Normal View History

2021-11-15 12:32:49 +01:00
# autobaan
![alt text](https://woody.collinduncan.com/api/badges/1/status.svg)
2021-11-15 12:32:49 +01:00
Automatic court reservation!
## Setup
### Requirements
- Node.js (18.x)
2021-11-15 12:32:49 +01:00
- npm (8.x)
2026-03-24 17:01:32 +01:00
- nvm
- Docker
- redis
2021-11-15 12:32:49 +01:00
#### 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
2026-03-24 17:01:32 +01:00
Using woodpecker to deploy this via pm2.