Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
snnbotchway committed Jul 13, 2023
1 parent 8bf293f commit daf9cad
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,19 @@ To get started, rename all instances of `project_name` in the codebase to the na

## Development Environment Setup

To set up your development environment, use the provided Docker Compose config in the base directory.
To set up your development environment, use the provided Docker Compose config in the base directory.

1. Run `docker compose up` to start the Flask app in a Docker container.

2. To set up pre-commit hooks, ensure that `pre-commit` is installed. You can install it using `pip install pre-commit`.
2. To set up pre-commit hooks, ensure that `pre-commit` is installed. You can install it using:

3. Run `pre-commit install` to install the hooks defined in `.pre-commit-config.yml`. This ensures that code is properly formatted and passes linting checks before commits are made.
```bash
pip install pre-commit
```

3. To install the hooks defined in `.pre-commit-config.yml`, run:

```bash
pre-commit install
```
This ensures that code is properly formatted and passes linting checks before commits are made.

0 comments on commit daf9cad

Please sign in to comment.