VUTTR Managament

A simple application to manage tools with their respective names, links, descriptions, and tags.

⚒ Used technologies:

• Node.js
• Typescript
• Nestjs
• Docker
• TypeORM
• PostgreSQL
• OpenAPI Swagger
• Clean Code, Clean Architecture

💻 Running the project locally

First clone the project on your computer and enter the created directory:

git clone https://github.com/matheustrres/nest-vuttr-management.git
cd nest-vuttr-management

Install the application dependencies

npm install

Set these environment variables correctly in the .env file

NODE_ENV=
PG_DATABASE=
PG_PASSWORD=
PG_PORT=5432
PG_HOST=
PG_USERNAME=
JWT_SECRET_KEY=
SESSION_SECRET_KEY=

Initialize the database service with docker

docker-compose up

Start the server from your terminal

npm run start

🚩 API Documentation

To view the API documentation with OpenAPI Swagger, after you have started the server properly with npm run start:dev, go to http://localhost:3000/api to check it out.

🎲 Features

• Tool

  • Creation
  • Deletion
  • Listing with pagination
  • Search by id

• User

  • Creation
  • Authentication