Git Product home page Git Product logo

fet's Introduction

FET - Fuel Efficiency Tracker

This is a project to help track fuel efficiency for cars. It is built off the node-turborepo-starter template.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • docs: All documentation for each service.
  • web: Website for more information about the project.
  • ui: a stub React component library shared by both ui applications

Environment Setup

Create .env file from apps/main/.env.example. Set the following:

APP_KEY= # External api key
PROXY_URL= # Proxy url for external webhooks to use

Create .env file from apps/journey-service/.env.example. Set the following after create a HERE app:

HERE_APP_ID= # Generated when creating an app
HERE_APP_KEY= # Generated when creating an api key under the app

Installing

Run the following command:

npm i

Build

To build all apps and packages (including sqlite database) run the following command:

npm run build

Create the database with

node apps/main/ace migration:run

See https://docs.adonisjs.com/guides/ace-commandline for more ace commands

Develop

To develop all apps and packages, run the following command:


npm run dev

Check it's working

echo '\n\nmain'
curl localhost:3333/api/health

echo '\n\njourney service'
curl localhost:3010/api/health

fet's People

Contributors

theithorian avatar

Watchers

 avatar

fet's Issues

Add Fuel Log Service

Description

Api which accepts fuel log data and enriches to add to db. Use message queue or schedule.

request:

{
  carId: number,
  totalCost: number,
  costPerLitre?: number,
  logTime: DateTime,
  petrolStationLocation?: number // How is this stored?
}

When costPerLitre is undefined or null, find the price at the log time for the provided station.

Use Redis for token storage

Currently use relational database for auth tokens. This should be moved to Redis for performance and to avoid having to clean up expired tokens

Add journey service

  • create new journeys and store in journey db
  • accept interval coordinates and increment journey distance
  • send completed journeys to database via schedule or message queue

Create UI for main

Create UI for main app which should include

  • Account management
    • Register, login
    • Integration key generation
  • Vehicle management
    • Add, update, remove vehicles
  • Journey dashboard

Configure main

Setup adonis config:

  • Database (sqlite & postgresql))
  • auth
  • cors
  • bodyparser
  • hash
  • drive?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.