hermes-api

Backend for Project Hermes - a queue system for DCISM students, by DCISM students.

Prerequisites

Ensure the following are installed:

• Git
• Visual Studio Code
  • Dev Containers Extension
• Docker

Getting Started

1. Clone the Repository

Clone the project to your local machine.

git clone https://github.com/usc-cisco/hermes-api.git

2. Open the Project

Open the project in Visual Studio Code:

1. Open the Command Palette (Ctrl + Shift + P or Cmd + Shift + P on macOS).
2. Run Dev Containers: Reopen in Container.

Note

The initial build may take some time.

3. Start the Development Server

Once the environment is ready, start the development server:

bun dev

Setting up the Database with Drizzle and Bun SQLite

1. Generate a migration

bun run db:migration-generate

2. Apply the migration that was just generated

bun run db:migrate

3. Add placeholder data with seeders

bun run db:seed

FAQ

1. Does this work with WSL?

Yes, read this article.

TL;DR: Windows users may need Docker Desktop, which detects WSL 2 if installed and can use it as the backend. The WSL integration is optional. The key is having Docker installed, regardless of WSL.

2. How can I close the container?

Exiting VSCode will automatically close the container and save resources. To further clean up artifacts, run these commands:

# Stop and remove all containers
docker stop $(docker ps -qa)
docker rm $(docker ps -qa)

# Remove all local images
# Warning: This will remove images locally, and you'll need to re-pull the images if needed
docker rmi $(docker images -qa)

3. How can I return to my local environment?

• Open the Command Palette (Ctrl + Shift + P or Cmd + Shift + P on macOS).
• Run Dev Containers: Reopen Folder Locally.

For setup issues, contact Jan Carlo.