- Description (What, Why, and How?)
- Install (Run) with Docker
- Installation without Docker
- Run together with the Flask Backend (with and without Docker)
- Screenshots of the Frontend Next js App
- Screenshots of the Flutter (Android + IOS) App
IFTA ya! is a fast, simple, and secure solution for calculating and reporting IFTA Taxes. It aims to help truck owners to keep their IFTA Tax Reports up to date while in the highway or office. There is no need to pass information to third-party companies as IFTA ya! has all the tools needed to fast store the information, analyze it, calculate the taxes, and create accurate reports for each truck and quarter. It also allows truck owners to manage their fleets, active drivers, and trucks.
The IFTA Tax Report of a truck have to be calculated and reported every 3 month by the truck's owner. To do so, the truck driver (which can be the truck owner or not) has to keep all the billing information about the fuel gas added to the truck as well as all the miles traveled. This information is then given to the truck owner, and then to a Tax specialist or to an expensive Tax software company. In this process, the driver can lose days searching for the bills that are often lost, and miles are not accurate reported. Therefore, the need for an alternative, in this case, IFTA ya!
IFTA ya! has 3 main apps: a Next js Frontend app (this repo), a Flask Backend API (where most of the logic and calculations occur), and a Flutter app for both Android and IOS devices (that is used for the truck driver, possibly the owner operator, to input new Entries when adding Fuel or recording Miles).
LINKS TO THE REPOSITORIES:
- NEXT js Frontend of IFTA ya! (This repo)
- Flask Backend API of IFTA ya!
- The Flutter application is kept ina private repository, however screenshots of it can be found at the section Screenshots of the Flutter (Android + IOS) App
When an owner operator creates an account, it is possible to administrate all the trucks, drivers, payments, and reports from the Next js App. The first step after registration is creating a Truck and a Driver to manage it (possibly, the owner operator itself). Then, the driver must download the Flutter app from the Google Play Store (for Android) or the App Store (For IOS). The application should be used by drivers to register the amount and price of the Fuel Gallons added and amount of Miles driven. Then the Flask Backend finds the quarter (based on the date) and the Tax for the fuel in each state, and with this information, it calculates and updates the IFTA Tax Report for each state visited by the driver in the truck. These changes can be visualized in the Next js App by the owner of the truck. This means that if a client has 10 trucks, he can assign a Driver to each of them, and each driver then downloads the Flutter app and keeps the IFTA Tax Report for the truck up to date without the client (owner of the truck) needing to do it himself.
When a driver logs in into the Flutter app, the app tries to find the truck that was assigned to him by the owner operator. Therefore, each time the driver adds fuel gallons or miles, it is not needed to specify the truck that is driving, as it has been already configured. To change the current driver the owner operator can go to the Next js App. Note that this method guarantees that even if a truck has multiple drivers in a quarter, its taxes can be easily deduced.
- An owner operator is a Truck driver that owns a truck.
- An owner operator can have multiple trucks and drive only one.
- A different IFTA Tax Report is presented for each truck that a client owns, that is, if a client has 10 trucks, then each truck has its own IFTA Tax Report that is independent of the others.
- Drivers do not have to present the IFTA Tax Report, as this is only a responsibility of the truck owner.
- To understand how IFTA Taxes are calculated and reported visit this Link. In reality, taxes are a bit more difficult to calculate and report as each state has its own standards and rules, however the previous link resumes the core of IFTA Taxes for a first approach.
-
Clone the repo:
git clone https://github.com/Ceci-Aguilera/ifta_frontend.git
-
Install Docker and Docker Compose
-
Configure the environment variables: Create an .env.local file inside the root folder and set up the following environment variables:
NEXT_PUBLIC_API_DOMAIN_NAME (The url of the backend, for example, https://backend_api.com/) -
Run the command:
docker-compose up --build
-
Congratulations =) !!! the app should be running in localhost:3000
-
Clone the repo:
git clone https://github.com/Ceci-Aguilera/ifta_frontend.git
-
Install dependencies:
npm install
-
Configure the environment variables: Create an .env.local file inside the root folder and set up the following environment variables:
NEXT_PUBLIC_API_DOMAIN_NAME (The url of the backend, for example, https://backend_api.com/) -
Run the app
npx next dev
-
Congratulations =) !!! the app should be running in localhost:3000
Note: Before following these steps clone this repository. From now on the selected folder that contains the clone will be referred as project_root. So far, it should look like this:
project_root
└── ifta_frontend
├── components
├── context
├── node_modules
├── pages
├── public
├── screenshots
└── styles- Assuming that your are at the project_root, clone the Flask Backend API repository:
Now the project_root folder should look like:
git clone https://github.com/Ceci-Aguilera/ifta_flask_backend_api.git
project_root ├── ifta_frontend └── ifta_flask_backend_api
-
-
Copy the content of the docker-compose-connect.yml to a new file docker-compose.yml in the project_root. The docker-compose-connect.yml file can be found at the root of this repository and also at the root of the Flask Backend API repository (Either file is fine to copy).
-
Follow the instruction to configure the environment variables of the Flask backend API that can be found in the section Install (Run) with Docker in the Readme.md of the Flask Backend API repository
-
Follow the instructions on the Install (Run) with Docker section of this Readme.md to configure the environment variables for this repo. The only env variable needed is the Flask Backend url, which by default should be http://localhost:5000. Note: Right now the project_root should look like:
project_root ├── ifta_frontend ├── ifta_flask_backend_api └── docker-compose.yml
-
Run the command:
docker-compose up --build
-
Congratulations =) !!! the frontend app should be running in localhost:3000 while the backend is at localhost:5000
-
-
- Follow the intructions of the Installation without Docker section in the Readme.md of the Flask Backend API repository to configure and run the backend.
- Follow the instructions of section Installation without Docker of this Readme.md. Modify the NEXT_PUBLIC_API_DOMAIN_NAME to be the url of the Flask Backend API (by default it is http://localhost:5050).
- Congratulations =) !!! the frontend app should be running in localhost:3000 while the backend is at localhost:5050
