Hoagie Calendar

Repository for HoagieCalendar

Getting Started

Frontend

Prerequisites

Before you begin, ensure you have Yarn installed. Make sure you have npm installed before runnning this command:

npm install -g corepack

You can set your yarn version to the latest version with:

yarn set version stable

If your yarn version isn't applied globally, you can install a global version of yarn with:

corepack install --global yarn@4.10.3

Installation

First, make sure you're in the frontend directory:

cd frontend

To install the necessary dependencies, run:

yarn

Running the App

Once the dependencies are installed, you can start the development server by running:

yarn dev

The app will now be running locally, and you can view it in your browser at localhost:3000.

Linting

You can run eslint to find common errors and bugs in your code with:

yarn lint

To try to automatically fix these errors, run:

yarn lint:fix

Formatting

You can run prettier to check the styling of your code and ensure consistent formatting:

yarn format

To automatically fix the formatting, run:

yarn format:fix

Backend

Prerequisites

Before you begin, ensure you have uv installed. We will be using uv as our package manager for the backend. uv can be installed by running:

brew install uv

Installation

Make sure you are in the backend directory by running:

cd backend

Create a virtual environment using the following command:

uv venv --prompt hoagie-calendar --python 3.13 .venv

This creates a virtual environment named hoagie-calendar contained within the .venv directory. Activate the virtual environment with:

source .venv/bin/activate

To install the relevant backend depedencies, run:

uv sync

This will install all required backend dependencies in the virtual environment.

Running the app

uv run manage.py runserver

License

This project is licensed under the MIT License. See the LICENSE file for details.