autobaan/README.md

# autobaan

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

So I don't forget... I am using GHA to create a container image which I pull on my server using podman. This then restarts the container on my server with the latest image. The container is backed by a systemd service to restart and start on boot.
Updating README and local execution 2021-11-15 12:32:49 +01:00			`# autobaan`

			`Automatic court reservation!`

			`## Setup`

			`### Requirements`

Updating node version, improving build process and adding required modules to dev dependencies 2022-11-07 11:44:57 +01:00			`- Node.js (18.x)`
Updating README and local execution 2021-11-15 12:32:49 +01:00			`- npm (8.x)`
Big ole refactor to using nestjs for some practice 2023-05-26 15:43:14 -05:00			`- nvm`
			`- Docker`
			`- redis`
Updating README and local execution 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`
Big ole refactor to using nestjs for some practice 2023-05-26 15:43:14 -05:00			`npm start:dev`
Removing rollup and relying on tsc to make builds. Also updated Docker to have a working development version 2023-01-20 09:38:50 +01:00			```
Readme updates for anyone who will read it (future me) 2023-02-10 23:51:41 +01:00
			`## 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`

			`So I don't forget... I am using GHA to create a container image which I pull on my server using podman. This then restarts the container on my server with the latest image. The container is backed by a systemd service to restart and start on boot.`