larissaperinoto / tasks-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tasks API

Descrição

API REST que permite criar, atualizar, buscar e deletar tarefas.

Tecnologias e Ferramentas

Adonis.js Postgres TypeScript

O projeto foi desenvolvido utilizando:

Rodando o projeto

Obs.: para rodar o projeto localmente é necessário ter o Node.js instalado. Também é necessário ter o banco de dados Postgres ou o Docker instalado.

Para rodar o projeto na sua máquina, inicie fazendo o clone deste repositório com o comando abaixo.

  git clone git@github.com:larissaperinoto/tasks-api.git

Instale as dependências.

 npm install

Rodando com o Postgres local

Caso possua o Postgres instalado em sua máquina, faça a substituíção das propriedades PG_USER e PG_PASSWORD no arquivo .env.

Rodando com o Postgres no container

Suba um container com o Postgres utilizando o comando abaixo.

docker run -it --name postgresss -e POSTGRES_PASSWORD=postgres -p 5432:5432  postgres

Caso queira usar um password diferente é necessário inserir a alteração no arquivo .env na propriedade PG_PASSWORD.

Escolha um cliente SQL de sua preferencia (DBeaver, Database Client, outros), faça login utilizando as credenciais e porta do banco e rode a query SQL presente no arquivo script.sql.

Após criar o banco, rode as migrations e seeders com o comando abaixo.

npm run start:db

Inicie a aplicaçao com o seguinte comando.

npm run dev

Documentação

Acesse a documentação das rotas disponíveis na API através da rota /docs.


Desenvolvido por Larissa Perinoto, © 2023.

About


Languages

Language:TypeScript 100.0%