collin/autobaan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Automatic court reservations
64 commits 2 branches 0 tags 1.5 MiB
TypeScript 98.9%
Dockerfile 0.7%
JavaScript 0.4%
Find a file
Collin Duncan 4d56881d12
Removing unique constraint from username column
2023-05-23 15:09:14 -05:00
.github/workflows Correcting docker build command 2023-05-23 15:09:14 -05:00
docker Adding label for GHCR image 2023-05-23 15:09:14 -05:00
src Removing unique constraint from username column 2023-05-23 15:09:14 -05:00
tests Switching to use SQLite instead of MySQL 2023-05-23 15:09:14 -05:00
.eslintrc.json Adding some ✨ pretty ✨ stuff 2023-05-23 15:09:09 -05:00
.gitignore Switching to use SQLite instead of MySQL 2023-05-23 15:09:14 -05:00
.nvmrc Updating node version, improving build process and adding required modules to dev dependencies 2023-05-23 15:09:11 -05:00
.prettierrc Adding some new packages for password/database features; updating old packages 2023-05-23 15:09:11 -05:00
jest.config.ts Spliting out server code, adding unit test for server 2023-05-23 15:09:12 -05:00
package-lock.json Switching to use SQLite instead of MySQL 2023-05-23 15:09:14 -05:00
package.json Correcting docker build command 2023-05-23 15:09:14 -05:00
README.md Removing rollup and relying on tsc to make builds. Also updated Docker to have a working development version 2023-05-23 15:09:13 -05:00
tsconfig.json Removing rollup and relying on tsc to make builds. Also updated Docker to have a working development version 2023-05-23 15:09:13 -05:00

README.md

autobaan

Automatic court reservation!

Setup

Requirements

  • Node.js (18.x)
  • npm (8.x)
  • gcc (g++-12)
  • nvm (optional)

Using nvm

  1. Install nvm
  2. nvm use will use version specified in .nvmrc
  3. nvm install-latest-npm will upgrade NPM to latest version (8.x)

Usage

npm install
npm run local <username> <password> <year> <month> <day> <startTime> <endTime> <opponentName> <opponentId>

Architecture

|======|
| User |
|======|
    |
[requests reservation]
    |
    |
    V
|===========|                             /---\                           |==========|
| Scheduler | ---[checks possibility]--->/ ok? \--[y/ forward request]--> | Reserver |
|===========|                            \     /                          |==========|
                                          \---/                                 |
                                            |                                   |
                                          [n/ save request]      [find possible, saved reservations]
                                            |                                   |
                                            V                                   |
                                        |==========|                            |
                                        | Database |<---------------------------|
                                        |==========|