VAAHAN

Maintain your vehicle info | Mileage Comparison | Fuel prices
Explore the docs »

View Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

A website for storing details related to your vehicle's mileage and performance just by entering your fuelling details. Get monthly details like : amount spent on fuelling, average mileage after every refill, compare mileage with similar vehicles

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo 📓

   git clone https://github.com/Saurav-Singh-Rauthan/Vaahan.git

2. Install NPM packages ⬇

   npm install

3. Create a copy of .env.example as .env.local 🏃

4. Enter your Firebase detials in .env.local 👨‍💻

   REACT_APP_API_KEY = <"firebase api key here">

   REACT_APP_BaseURL = <"firebase realtime db baseURL">

   REACT_APP_AuthDomain = <"firebase sdk authdomain">

   REACT_APP_ProjectID = <"firebase sdk project-id">

   REACT_APP_StorageBucket = <"firebase sdk storagebucket">

   REACT_APP_MessagingSenderId = <"firebase sdk msg sender id">

   REACT_APP_AppId = <"firebase sdk app id">

   REACT_APP_MeasurementId = <"firebase sdk measurement id">

5. set up firebase rules for realtime database

• 

6. start the project 🚀

    npm start

(back to top)

Usage

• Dashboard

  • 

• Add record

  • 

• Add Vehicle

  • 

• SpeedDial

  • 

• Fuel Price

  • 

• User Account

  • 

For more examples, please refer to the Vaahan.netlify.app

(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 :D!

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)

License

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

(back to top)

Contact

Your Name - [email protected]

Project Link: Vaahan

(back to top)

Acknowledgments

• Fuel Price API by @its-arpit

(back to top)