diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..2dd89d4 --- /dev/null +++ b/README.MD @@ -0,0 +1,87 @@ +
+
+ + Logo + + +

Subway Schedule

+ +

+ A school project using php vanilla to provide user-saved real-time information on metro stations +
+
+ View Demo + · + Report Bug + · + Pull request +

+
+ + +## What is Subway Schedule + + + + + +### Built With + +This section list major frameworks/libraries used + +* ![](https://img.shields.io/badge/php-20232A?style=for-the-badge&logo=php) +* ![](https://img.shields.io/badge/SqLite-20232A?style=for-the-badge&logo=mysql) +* ![](https://img.shields.io/badge/Bootstrap-20232A?style=for-the-badge&logo=bootstrap) + +

(back to top)

+ + + +## Getting Started + +Now let's see how to set up an subway schedule instance. +### Prerequisites + +First, install nginx, php and mysql on your server.
+Then, create a user with a database + + +### Installation + +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ + +1. Clone the repository + ```sh + cd /my/directory + git clone https://github.com/itsmrval/subway . + ``` +2. Copy the example config + ```sh + cp config_example.php config.php + ``` +3. Change `config.php` permissions + ```sh + chmod 600 config.php + ``` +4. Copy and rename `exemple.env` + ```js + cp exemple.env .env + ``` + 5. Complete `config.php` + * idfm_api_key with your [IDFM PRIM account](https://prim.iledefrance-mobilites.fr) + * db_host / db_user / db_password / db_name with mysql infos. + +6. Run your nginx server + +

(back to top)

+ + + + + + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + +

(back to top)