LpgConsumptionCostCalculator

The LPG consumption cost calculator is a web application for storing, analyzing and managing the costs of fuel and gas consumption for cars with an LPG installation.

Report Bug · Request Feature

Table of Contents

• About the Project
• Used Technologies
• Getting Started
• Usage
• Contributing
• Contact

About The Project

LpgConsumptionCostCalculator is a ASP.NET MVC5 web app designed for storing, analyzing and managing the costs of fuel and gas consumption for cars with an LPG installation. Project created for my own needs to support me and my wife with cooperatively analyzing and managing costs of travel with petrol car using LPG installation, but it can either be use for diesel cars with LPG installation. More details in Usage section.

Used Technologies

• ASP.NET MVC v5.2.7.0
• Firebase Database
• Autofac
• AutoMapper
• Okta
• Bootstrap v4.4.1
• SB Admin 2 v4.0.7
• jQuery v3.3.1
• Chart.js v2.9.3
• Font Awesome 4.7.0

Getting Started

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

• Download the latest stable version from the download tab and unzip it to your folder
• Open the solution in Visual Studio 2019.
• Clean solution.
• Build the solution to install Nuget packages.
• In case of RoslynCompilerBug run following in PM Console:

Update-Package Microsoft.CodeDom.Providers.DotNetCompilerPlatform -r

• Change in web project in Web.config the data needed for Okta Identity:

    <add key="okta:ClientId" value="yourClientId" />
    <add key="okta:ClientSecret" value="yourClientSecret" />
    <add key="okta:OktaDomain" value="yourOktaDomain" />
    <add key="okta:Token" value="yourOktaToken" />

• Change in data project in FirebaseConn.cs file the data for your Firebase Database connection:

namespace LpgConsumptionCostCalculator.Data.Services
{
    public class FirebaseConn
    {
        private const String databaseUrl = "yourDatabaseUrl";
        private const String databaseSecret = "yourDatabaseSecret";

• Run application
• Fire up your browser and open url https://localhost:44396/
• Enjoy ;-)

Please note that I have tested the app in Chrome browser where no issues where discovered.

Usage

This section contains screens of application's parts with all main functionalities.

List of cars

After clicking List in CARS section from navigation bar the list of cars is shown. Guest can view the list of entered cars and check selected car details on seperate modal. In addition, it is possible to search the list, order columns and set the number of entries on one page.

Logged user can additionally add new car, edit or delete existing one.

List of receipts

After clicking name of the chosen car and then selecting Fuel receipts in FUEL RECEIPTS section from navigation bar the list of receipts is shown. Guest can view the list of receipts for selected car and check details of fuel recipt. In addition, it is possible to search the list, order columns and set the number of entries on one page.

Logged user can additionally add fuel receipt, edit or delete existing one.

Important data, trends and reports generating

After clicking name of the chosen car and then selecting Graphs in FUEL RECEIPTS section from navigation bar the graphs and reports section is shown. Guest can view the important fuel consumption and fuel price data from selected time range. In addition the graphs with fuel consumption and fuel price for 100 km is shown.

Logged user can additionally export report to PDF or CSV file from selected time range.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

Contact

Mateusz Donhefner

Project Link: https://github.com/matdon90/LpgConsumptionCostCalculator