Orlando Recycling

Table of Contents

• Overview
• Installation
• Run the application
• Testing
• API Documentation
• How to contribute
• Reporting bugs, issues, or feature requests
• Devcontainer

Overview

To create an application that helps citizens of Orlando and its surrounding areas to differentiate between recyclable and non-recyclable goods and provide more information on how they can properly recycle. We will also support the Mobile-Development teams through a Backend API.

Installation

Prerequisites

• Python 3.12
• MySQL 8.3.0

Setup

1. Clone the repository

git clone https://github.com/anazworth/orlando-recycling.git

2. Install the dependencies

pip install -r requirements.txt

3. Create a .env file in the root of the project and add the environment variables found in the .example-env file.

cp .example-env .env

4. (Optional) User the docker-compose file to create a MySQL database

cp example-docker-compose.yml docker-compose.yml

Edit the docker-compose.yml file to add the MySQL environment variables.

docker-compose up -d # Start the MySQL database

5. Run the database migrations

python manage.py migrate

Run the application

python manage.py runserver

Testing

1. Ensure that the testing dependencies are installed

pip install -r requirements.txt -r requirements-test.txt \
playwright install \
playwright install-deps

2. Ensure that the setup steps have been completed

3. Run the tests

python manage.py test

API Documentation

The API documentation is available at /swagger when the application is running and the ENV environment variable is set to development.

How to contribute

All development is done in the dev branch.

To contribute to the project, follow these steps:

1. Fork the repository
2. Create a new branch
3. Make your changes
4. Push your changes to your fork
5. Create a pull request to the 'dev' branch.
6. Wait for the pull request to be reviewed and merged.

Before creating a pull request, please ensure that all tests pass and that the code is formatted correctly. Ensure that no secrets are pushed to the repository. Create tests for any new features and bug fixes.

Use pylint to check the code for formatting issues.

pylint <changed_files>

Reporting bugs, issues, or feature requests

If you find a bug, issue, or have a feature request, please open an issue in the repository.

devcontainer

This project includes a devcontainer configuration for Visual Studio Code. To use it, you must have the Remote - Containers extension installed.

To open the project in a container, click on the green icon in the bottom left corner of Visual Studio Code and select "Reopen in Container".

All the dependencies are installed in the container and the application is ready to run.

Don't forget to create a .env file in the root of the project and add the environment variables found in the .example-env file.

Docker is required to use the devcontainer.