diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9c15148 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing + +To contribute you need to have [git](https://git-scm.com/) and [UV](https://docs.astral.sh/uv/) setup. + +## Setup + +Set up the repository via a git clone and setup a new branch using the following commands: + +```bash +git clone git@gitlab.com:KaranJayachandra/match_up.git +cd match_up +git checkout develop +git branch <branch-name> +git checkout <branch-name> +``` + +Now we can install the dependencies using: + +```bash +uv sync +``` + +A database URI needs to be added to let the application know where to create a test database by creating a `.flaskenv` file in the root directory containing the variable `SQLALCHEMY_DATABASE_URI=sqlite:///app.db`. Now, we need to initialize a database for testing via the following commands: + +```bash +uv run flask init +uv run flask migrate +``` + +We are now ready to run the flask application using: + +```bash +uv run flask run +``` |