RevisionsCode

A website to revise the "code de la route"

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This project is a website to revise the "code de la route". It's composed of 3 parts:

• The actual website where you can enter your statistics and see your progress
• A chrome extension that allows you to automatically send your statistics to the website
• A TypeScript script that get the questions of "Passe Ton Code"

(back to top)

Built With

This project was built using these technologies.

• PHP
• MySQL
• HTML
• CSS
• JavaScript
• TypeScript

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

• MySQL
• PHP
• A web server
• A browser

Installation

1. Clone the repo

   git clone https://github.com/caranouga/RevisionsCode.git

2. Create the database

    mysql -u root -p < init.sql

3. Start the web server
4. Open the website in your browser
5. Enjoy!

(back to top)

Usage

You can use this project to revise the "code de la route". You can also use the chrome extension to automatically send your statistics to the website. Or you can use the TypeScript script to get the questions of "Passe Ton Code" (SOON).

(back to top)

Roadmap

• Create the website
• Create the chrome extension
• Make the extension work with Firefox
• Implement the questions gather thanks to the TypeScript script in the website
• Update the init.sql

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 [repo-licence] License. See LICENSE.txt for more information.

(back to top)

Contact

Caranouga - malonepayet@gmail.com

Project Link: https://github.com/caranouga/RevisionsCode

(back to top)