Skip to content

Commit

Permalink
docs: Add dev install steps
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe-Heffer-Shef committed Jun 17, 2024
1 parent 74bd087 commit b30c5be
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion backend/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,33 @@ This directory contains the code files that define the Flask backend API app. Th
- `blueprints/` contains the app code. See: [Modular Applications with Blueprints](https://flask.palletsprojects.com/en/2.3.x/blueprints/)
- `tests/` contains unit tests. See [Testing Flask Applications](https://flask.palletsprojects.com/en/3.0.x/testing/)
- `pyproject.toml` specifies the [Python package](https://packaging.python.org/)
- `MANIFEST.in` tells the build system what [other files to include](https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html#controlling-files-in-the-distribution) (such as the static files)
- `MANIFEST.in` tells the build system what [other files to include](https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html#controlling-files-in-the-distribution) (such as the static files)

## Installation

To create a virtual environment

```bash
python -m venv .venv
```

Activate the environment

```bash
# Linux
source .venv/bin/activate

# Windows
.venv\Scripts\activate
```

To install the package in [editable mode](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):

```bash
pip install --editable ./backend
```

## Usage

To run the app in development mode:

Expand Down

0 comments on commit b30c5be

Please sign in to comment.