Installation¶

This guide will walk you through setting up the project for local development.

Prerequisites¶

Before you begin, ensure you have the following installed:

Docker and Docker Compose: For running the application and its services in a containerized environment.
Python 3.11+: For running the application locally.
Poetry: For managing Python dependencies.

Clone the repository:

git clone https://github.com/bvandewe/starter-app.git
cd starter-app

Install Python dependencies: Use Poetry to install the required Python packages.
```
make install
```
This command will create a virtual environment and install all dependencies defined in pyproject.toml.
Install pre-commit hooks: This project uses pre-commit hooks to enforce code quality. Install them by running:
```
make install-hooks
```
Install UI dependencies: The frontend assets are built using Node.js.
```
make install-ui
```

This repository is designed to be used as a template for new projects.

Create a new repository from this template: Click the "Use this template" button on the GitHub repository page to create a new repository with the same structure and files.
Rename the project: After cloning your new repository, run the rename_project.py script to update the project name throughout the codebase.
```
python scripts/rename_project.py --new-name "Your New Project Name"
```
This will replace all occurrences of "Starter App" and its variants (e.g., starter-app, starter_app) with your new project name. It is recommended to run with the --dry-run flag first to see the changes before they are applied.