Skip to content

e-motion-apps/e-motion-api

Repository files navigation

E-motion API

logo.png

Project developed to allow checking available options of urban mobility.

This is API part of the project, which is responsible for fetching data from different providers and returning it in unified format.

API is consumed by applications in those repositories:

API documentation may be found in

Swagger

Available providers

  1. Baqme
  2. Beam
  3. Beryl
  4. BinBin
  5. Bird
  6. BitMobility
  7. Bolt
  8. Docomo
  9. Dott
  10. Felyx
  11. GoSharing
  12. Hop
  13. Hulaj
  14. Lime
  15. Link
  16. Neuron
  17. Quick
  18. Ryde
  19. Sixt
  20. Spin
  21. Tier
  22. Urent
  23. Veo
  24. Voi
  25. WheeMove
  26. Wind
  27. Zwings

Local development

cp .env.example .env
make init
make shell
  # inside container
  npm run dev

Application will be running under localhost:3851 and http://escooters.blumilk.localhost/ in Blumilk traefik environment. If you don't have a Blumilk traefik environment set up, follow the instructions in this repository.

Commands

Before run every command from below list, you must run shell:

make shell

Command list

Composer:

composer <command>

Run backend tests:

composer test

Lints backend files:

composer cs

Lints and fixes backend files:

composer csf

Artisan commands:

php artisan <command>

Runs a queue that processes importers' jobs:

php artisan queue:work

Project is no longer maintaining frontend part, and will be moving to API only.

If you want to run frontend, you can use following commands:

Compiles and hot-reloads frontend for development:

npm run dev

Compiles and minifies for production:

npm run build

Lints frontend files:

npm run lint

Lints and fixes frontend files:

npm run lintf

Containers

service container name default host port
app escooters-app-dev 3851
database escooters-db-dev 3853
mailpit escooters-mailpit-dev 8566
redis escooters-redis-dev 3852