Monitoring-Mtl/Bixi-Api

![GitHub contributors](https://img.shields.io/github/contributors/Monitoring-Mtl/Bixi-Api?color=green) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Monitoring-Mtl/Bixi-Api/main) ![GitHub issues](https://img.shields.io/github/issues/Monitoring-Mtl/Bixi-Api) ![GitHub top language](https://img.shields.io/github/languages/top/Monitoring-Mtl/Bixi-Api)

Monitoring Mtl - Bixi-Api

Table of Contents

About the Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage

Test Coverage Report

Roadmap
Contributing
Contact
Acknowledgments

About the Project

This is a REST API for querying public Bixi data aggregated over time in Monitoring-Mtl

(back to top)

Built With

Here is the list of frameworks and tools we use in the project:

(back to top)

To Get Started

Prerequisites

Python 3.11 or newer
AWS CLI
Docker for local testing

Installation

Below is an example of the procedure to install the project locally and launch the project to test that your work environment is functional.

Clone the repository

git clone https://github.com/Monitoring-Mtl/Bixi-Api.git

Install Python packages

cd Bixi-Api
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Launch the local serverless application using AWS SAM
```
sam build
sam local start-api
```

(back to top)

Usage

TODO

Test Coverage Report

TODO

(back to top)

Roadmap

See the open issues for the full list of proposed features (and known issues).

(back to top)

Contributing

Hoping that the project continues to grow with your contributions. Thank you

We have decided to use a Trunk Based Development structure for branch management. To ensure every Pull Request (PR) correlates with tracked work, all PRs must be associated with an existing issue. If the relevant issue does not exist, please create one before proceeding with your contribution. Here's the updated procedure:

Clone the Project (if not already done).
Check if an issue exists for your contribution; if not, create one.
Create a Feature or Documentation branch, including the issue number in the branch name (git checkout -b feature/123-AmazingFeature).
Commit your Changes (git commit -m '#123: Add AmazingFeature').
Push the Branch (git push origin feature/123-AmazingFeature).
Open a Pull Request and link it to the issue.

(back to top)