Skip to content

Farah404/EcoCar

Repository files navigation

Contributors Forks Stargazers Issues

EcoCarPub.mp4

EcoCar

A simple and efficient website to reserve and provide car pooling, car rental or parcel services.
ISIKA Project 2 specifications - CDA17 Group 1
Explore the docs »

Report Bug · Request Feature

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

About The Project

While many carpooling services already exist, EcoCar wishes to propose not only price reductions but amso a revolutionnary way to satusfy the needs of the community.

Here's how:

  • A simple and efficient way to propose and provide CarPooling/CarRental/Location services
  • A messaging system between users
  • An integrated internal currency: EcoCoins

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

  • VisualStudio
    npm install npm@latest -g
  • MySQL
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://ecocar.com
  2. Clone the repo
    git clone https://github.com/Farah404/EcoCar.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Please refer to the Documentation

(back to top)

Roadmap

  • AccountCreation
    • Profile
  • ServiceCreation
    • CarPoolingService
    • CarRentalService
    • ParcelService
    • SearchList
  • ServiceReservation
    • As a provider
    • As a consumer
  • EcoCoins transactions
    • Invoices
  • Banking authentification
    • Invoices
  • Messaging system
    • User to User
    • User to Admin

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)

Contact

EcoCar Dev Team- @twitter_handle - ecocardevteam@gmail.com

Project Link: https://github.com/Farah404/EcoCar

(back to top)

Acknowledgments

  • Isika for providing us this opportunity
  • Cats who entertained us

(back to top)

About

Projet 2 ISIKA CDA17

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published