Code Monkey home page Code Monkey logo

idfm-api's Introduction

Contributors Forks Stargazers Issues MIT License LinkedIn

RER B informations viewer

Explore the docs »
--------------------
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

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.

(back to top)

Built With

  • Python
  • Flask
  • JSON
  • HTML
  • CSS
  • JavaScript
  • Bootstrap

(back to top)

Getting Started

You can install this project by following these steps.

Prerequisites

  1. Clone the repository on your computer.

    git clone https://github.com/Isnubi/IDFM-API.git
    cd IDFM-API
    • If Git is not installed, you can install it from here or download the repository as a zip file from here
      sudo apt install git
  2. Run the install script as user (not root).

    • For Debian-based systems (Debian, Ubuntu, Mint, etc.):
      sudo chmod +x apt_install.sh
      sudo ./apt_install.sh
    • For Windows systems:
      • Install Python from here
      • Install Pip from here
      • Install pip dependencies:
        pip install -r requirements.txt
  3. 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.

Installation

  1. Get an API Key at https://prim.iledefrance-mobilites.fr/
  2. Enter your API Key in private/config.py
    idfm_token = "YOUR_API_TOKEN_HERE"
    
  3. Run the flask application
    flask --app app.py run

(back to top)

Usage

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

(back to top)

Roadmap

  • Add a map page

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

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Isnubi - @Louis_Gambart - [email protected]
Discord: isnubi#6221

Project Link: https://github.com/Isnubi/IDFM-API

(back to top)

idfm-api's People

Contributors

isnubi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.