📚 Sys Library

Tecnologias   |    Documentação Oficial   |    Projeto   |    Instalação   |    Uso   

🌐 Tecnologias

O projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• Express
• Prisma ORM

🌐 Documentação Oficial

A documentação oficial está disponível em:

• Documentação Swagger

💻 Sobre o Projeto

Um gerenciador de tarefas simples para organizar o dia.

📦 Instalação

Para clonar o projeto, com o Git já instalado no seu computador, execute o comando abaixo:

git clone https://github.com/thecastrodev/syslibrary_ts.git

Em seguida, abra seu editor de código na pasta do seu projeto.

Para instalar as dependências execute o comando abaixo na pasta do projeto:

npm install

🔨 Uso

A primeira coisa a ser feita é configurar o Banco de Dados com o Prisma. Rode o seguinte comando:

npx prisma migrate dev

Para visualizar as tabelas do banco de dados, execute o comando abaixo:

npx prisma studio

Agora, para rodar o projeto basta executar o comando abaixo com o terminar aberto na pasta do seu projeto:

npm run dev

Com o projeto rodando, agora você pode acessar a seguintes rotas pelo seu navegador:

http://localhost:3333/api/v1/

Usando o Insomnia, você poderá acessar as seguintes rotas de usuários:

GET http://localhost:3333/api/v1/auth/info

POST http://localhost:3333/api/v1/auth/register
  body (não copie a palavra "body", só o objeto abaixo):
  {
    "username": "your_username",
    "name": "Your Name",
    "email": "your_email@email.com",
    "password": "password123"
  }

PATCH http://localhost:3333/api/v1/auth/patch
  {
    "username": "your_username",
    "name": "Your Name",
    "email": "your_email@email.com",
    "password": "password123"
  }

Desenvolvido por @thecastrodev