Skip to content

FlorianWoelki/driver-simulator

Repository files navigation

Contributors MIT License

πŸš– Driver Simulator

Table of Contents

About the Project

Header of Product

Built With

Getting Started

This guide will get you started with driver-simulator!

Prerequisites

You need the latest npm version.

npm install npm@latest -g

Installation

  1. Get a free API key at Open Route Service
  2. Clone the repo
git clone https://github.com/FlorianWoelki/driver-simulator.git
  1. Install NPM packages
npm install
  1. Create a new file in the src directory named config.js
export const config = {
  API_KEY: 'YOUR API KEY HERE'
};
  1. You are set up and now you can start the application
npm run serve

Usage

You can do whatever you want with this project. Notice, that it is only a simulation of drivers.

There is no real driving. I won't store any information about your location or something else!

In addition, you can click on the driver to see his information about him and you can navigate around using the bottom right button.

You can set your pickup and destination location and will draw a route for you.

Contributing

If you want to contribute to this project, just visit the CONTRIBUTING file.

Here is a easy way to contribute:

  1. Fork the Project
  2. Create your feature branch (git checkout -b feature/AwesomeFeature)
  3. When finished use lint (npm run lint)
  4. Commt your changes (git commit -m "Added some amazing features)
  5. Push to the Branch (git push origin feature/AwesomeFeature)
  6. Open a Pull Request

License

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

Acknowledgements