README.md

🚴 Velo Laravel App

Velo Laravel App 🚴

This is the official Velo App documentation

Table of Contents

1. About The Project
   • Project Main Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Demo
5. Roadmap
6. Contributing
7. Contact
8. Acknowledgments

📃 About The Project

"Velo.tn"is an application that brings together people who are passionate about bicycles. Its aim will be to insist on the need to adopt more massively cycling as an alternative means of transport to the car.

📜 Project Main features

1. 🚲 Bikes Management
2. 💶 Bike Rentals Management
3. 🎗️ Bike Associations Management
4. 🚴 Bike Rides Management
5. 🎏 Bike Events Management
6. 🙋 Users Management

(back to top)

🚀 Built With

Velo.tn is built using Laravel Framework. You may find below the list of the frameworks/libraries that we used to build our project :

(back to top)

✨ Getting Started

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

🚧 Prerequisites

You may find below the list of things you need to use this project :

• Make sure MySQL is running on your system.
• You will need to install the "yarn" or "npm" command line.

🛠 Installation

In order to install the app you need to follow the instructions below :

1. Clone the repo

   git clone https://github.com/SyrineZahras/Velo

2. Install project dependencies

   composer install

3. Install NPM packages dependencies

   npm install && npm run dev

4. Rename .env.example file to .env on the root folder.

5. Open your .env file and change the database name DB_DATABASE to whatever you have, username DB_USERNAME and password DB_PASSWORD field correspond to your configuration. Also don't forget to set MAIL_USERNAME and MAIL_PASSWORD values .

6. Generate key to set APP_KEY value in .env

   php artisan key:generate

7. Migrate the database

   php composer migrate

8. Link the storage file public/storage with storage

   php artisan storage:link

9. Run the server on

php artisan serve

11. Open localhost:8000 in the browser and that's it you can enjoy the project 🎉!

(back to top)

⚡ Usage

Login Page	Register Page
Forget Password Page	Home Page
Dashboard	User Profile Page
Rides Management	Rides Tracking
Rides Tracking - 1	Events Page
Associations Management	Create an Association

Tracking Rides	Ride Plan

🌎 Demo

Untitled.design.1.mp4

(back to top)

🚩 Roadmap

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

• Phase 1 : Template Integration using Blade

  • Frontoffice template
  • Backoffice template

• Phase 2 : Authentication Integration using JetStream

  • User Authentication
  • User Profile Management
  • Password Update
  • Password Confirmation
  • Account mail verification

• Phase 3 : CRUD Integration

  • Bikes Management
  • Bike Rentals Management
  • Bike Associations Management
  • Bike Rides Management
  • Bike Events Management

(back to top)

😎 Contributing

If you have a suggestion that would make this project better, please fork the repo and create a pull request. Any contributions you make are greatly appreciated. Don't forget to give the project a star! Thanks again!

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

(back to top)

💌 Contact

Project Members :

Ahlem Laajili	Skander Turki	Syrine Zahras	Hichem Ben Zammal	Nesrine Ben Mahmoud

(back to top)

🙌 Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Img Shields
• GitHub Pages
• Font Awesome

(back to top)