README.md

Fuel price

App for monitoring fuel prices in Germany.

View Demo · Report Bug · Request Feature

About The Project

This application will allow the user to monitor the current price of fuel. It is also possible to see the dynamics of price changes over a certain period. Currently, the app uses the api, which provides data on fuel in Germany.

Built With

• 
• 
• 
• 
• 

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Personally, I use yarn as a package manager

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

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 repo

   git clone https://github.com/milk-2-dev/fuel-price.git

2. Install NPM packages

   yarn install

3. Copy .env file and create your env file:
   • for server folder 'local' or 'development'
   • for client folder 'localenv' or 'development'
4. Run projects locally:
   • for server

     yarn dev:local

   • for client

     yarn dev:local

Roadmap

• Add Changelog
  • Add the ability to add stations to favorites
    • Add filter for favorites
• Add possibility to add new stations and cities
• Show a price forecast
• Create mobile app

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

(back to top)

License

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

Contact

Milk - [email protected]

Project Link: https://github.com/milk-2-dev/fuel-price

(back to top)