theithorian / fet Goto Github PK

Have 3 workflows;

• lint
• build
• test

Adonis has factories for setting up tests: https://docs.adonisjs.com/guides/models/factories

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.

Description

Stateless service which you can ping with coordinates to ask if you are currently at a petrol station. Should return station details if you are.

request:

{ coordLong: number, coordLat: number }

Data Providers

https://developer.here.com/documentation/fuel-prices/dev_guide/topics/example-fuel-station.html

https://ukvehicledata.co.uk/Fuel-Prices

Configure apps\main\config\cors.ts for use case.

Add

• Vehicles
• User config
• Odometer Reading

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

Use api schema to generate documentation
Use schema to test api shape as per https://japa.dev/docs/plugins/assert#open-api-testing

• 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

Add option to hide errors for production
See https://docs.adonisjs.com/guides/exception-handling#handling-exceptions-globally

• Add routes to main
• Add rate limiter

Create UI for main app which should include

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

Setup adonis config:

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