Explore the docs »
--------------------
Report Bug
·
Request Feature
Table of Contents
This project is a simple viewer for RER B informations. It uses the Ile de France Mobilités REST API to get the informations and display them using Flask.
You can install this project by following these steps.
-
Clone the repository on your computer.
git clone https://github.com/Isnubi/IDFM-API.git cd IDFM-API
-
Run the install script as user (not root).
-
If you're on a Windows system, you need to install Poppler. You can get it here
- Extract the archive
- Add the path to the bin folder to your PATH environment variable. You can follow this tutorial to do so.
- Get an API Key at https://prim.iledefrance-mobilites.fr/
- Enter your API Key in
private/config.py
idfm_token = "YOUR_API_TOKEN_HERE"
- Run the flask application
flask --app app.py run
Once it run, the application is accessible at http://localhost:5000/.
You have an index page with button to access the different pages:
- Home: The home page with the button to get, on the same page, the map and the trafic informations
- Add a map page
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.md
for more information.
Isnubi - @Louis_Gambart - [email protected]
Discord: isnubi#6221
Project Link: https://github.com/Isnubi/IDFM-API