dzfranco/ultra

My Microservice

This repo is just a simple cars management API sample

• My Microservice
  • About this repo
  • Starting this project
  • Endpoints
  • Other Goodies

About this repo

This repo uses the following technologies

• TypeScript - Main Language
• NestJS - Framework to build server-side apps
• TypeORM - ORM for typescript
• MySQL - Database engine
• Jest - Testing utils
• Docker - Containerization platform

Starting this project

To develop this project you can use Docker Compose and run the following command:

$ docker-compose up

That should start MySQL and the project. You could also run the following and run the container with an active MySQL Database.

Remember that the API will start on port 3000, thus the URL would be http://127.0.0.1:3000

Endpoints

The endpoints can be found here

Other Goodies

There is an example deployment for a Kubernetes integration (i.e Rancher)