Rpg Api

🚧 Status

Rpg Api 🚀 Under construction... 🚧

---

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

Este projeto tem como foco a simulação de algumas funções encontradas em RPGs. Este projeto é voltado para estudo, onde eu aprofundo meus conhecimentos sobre, NestJs, Docker, Prisma, Typescript, Testes Unitários e Segurança de APIs.

This project focuses on simulating some functions found in RPGs. This project is study-oriented, where I improve my knowledge about NestJs, Docker, Prisma, Typescript, Unit Testing and API Security.

✨ Features

✔️ Create User
✔️ Authenticate User
✔️ Create Character;

🚀 Technologies

The following tools were used in this project:

• TypeScript
• NestJs
• PrismaJs

✅ Requirements

Before starting 🏁, you need to have Git, Node, and Docker or Postgresql installed.

🏁 Starting

# Clone this project
$ git clone https://github.com/idylicaro/rpg-api

# Access
$ cd rpg-api

# Install dependencies
$ yarn

# If you don't make a Database in postgresql, run:
$ docker-compose up -d

# Fork .env.example with .env and edit.

# Run the project
$ yarn start

# The server will initialize in the <http://localhost:3000>

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Idyl Ícaro

 

Back to top