Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.45 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.45 KB
Raw

Home Broker

The target of this simple project is to create and list orders and assets, something like a Home Broker.

📝 Requirements

💡 Features

You can create and list Orders and Assets with this API, more details in this file.

🚀 How to Run?

Choose which way will be better for you, if running directly on your machine or with Docker.

🐋 Running With Docker

First of all, run docker-compose in your command line:

docker-compose up

Open a new command line and access the app service:

docker-compose exec app bash

Execute the following commands, one to install dependencies and other to generate Prisma Models to work with database:

npm install && npx prisma generate dev

If everything went fine, run the project:

npm run start:dev

Congrats! You're now able to have fun with this simple home broker API ;)

⚒ Running locally

npm install
npx prisma generate dev
npm run start:dev

🔄 How to use this API?

You'll have all entpoints in this file.

⚙️ Made With:

  • Prisma 4.16.1
  • NestJS 10.0.0
  • Docker 20.10.7
  • MongoDB 5.0.17

🧑🏻‍💻 Author

Matheus Oliveira da Silva - Github | Linkedin