This is a REST API for querying public Bixi data aggregated over time in
Monitoring-Mtl
Here is the list of frameworks and tools we use in the project:
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
TODO
TODO
See the open issues for the full list of proposed features (and known issues).
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:
git checkout -b feature/123-AmazingFeature
).git commit -m '#123: Add AmazingFeature'
).git push origin feature/123-AmazingFeature
).(haut)
Special thanks to
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge [contributors-url]: https://github.com/Monitoring-Mtl/Serverless-API/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[AWS]: https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white
[GitHub]: https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white
[GitHubActions]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white
[AWS]: https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white
[Python]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
This work is licensed under a Creative Commons Attribution 4.0 International License.