elebuild
What do you need?
- Docker
docker-compose
- (If compiling) A rust build environment
Getting it up
Follow the steps below in the given order.
Getting the db on
- Set the env variables Look at the environment variables section; Place it in a
.env
file. - Use docker compose to start the database
docker-compose up -d
Compiling it (If you dont have an executable)
- Use the rust toolchain, preferably the latest stable one.
- Build it
cargo build --release
- Your executable will be present in the
target/release
directory.
Note:
- Use
cargo run --release
to directly compile and run - Database needs to be reachable while compiling
Running it
- Run the executable
- ???
- Profit
Note: The executable is silent, use the rest api to talk to it. This file can be interacted with the VSCode extension "Rest Client" (humao.rest-client) for testing, but otherwise these are curl requests that can be used appropriately.
Environment variables
VAR | DESC | FOR |
---|---|---|
POSTGRES_USER | db | |
POSTGRES_PASSWORD | db | |
DATABASE_URL | connection url | server |
What it has
User -> Name, USN, PWD, email, Dept Sub -> CC, Sem, Dept, isGlobal, maxCapacity Booking -> USN,CC
What it does
- Mass import users
- Mass import subjects
- Users book subjects? Better just add any amount
- Users can see stats?
- Report comes with result
TODO
Aims
- Add subject booking recording
- Add subject booking computations
- Auth
- Consider enabling and disabling bookings
Misc
- Understand existing codebase
- Consider conventional composition for the sake of my sanity