vila-front-api: A TypeScript repository from rafael-angonese

🍄 Sobre

Esse projeto é uma API para utilização no projeto do módulo 05 (Front-End) da Formação WebDev Full Stack da Resilia Educação.

🧪 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

🚀 Demo

Acesse a Demo no Heroku.
API <https://vila-api.herokuapp.com/>
Documentação <https://vila-api.herokuapp.com/api-docs>

Arquivo com a Collection do Insomnia .Insomnia_Collection.json

🎮 Ambiente de desenvolvimento

Para executar o ambiente de desenvolvimento deste projeto é necessário possuir o node instalado em sua máquina.

node --version
v16.0.0

Possuir o yarn instalado.

node --version
1.22.17

Para rodar o projeto é necessário rodar um banco Mongodb, sugiro o uso do docker e docker-compose. O projeto já contém um arquivo do docker-compose configurado para isso, então basta usar o seguinte comando:

docker-compose up -d

Ou alternativamente configurar o banco manualmente.

Usei o dotenv para variáveis de ambiente, então pode-se renomear o arquivo .env.example para .env e aproveitar as variáveis de ambiente de lá. Por padrão elas apontam para o banco PostgreSQL do docker-compose.

Crie um arquivo .env com base no arquivo .env.example

O próximo passo é instalar as dependências:

🚀 Como executar

# Instale as dependências
$ yarn

# Alternativamente instale as dependências exatas do lock file
$ yarn install --frozen-lockfile

# Gerar o prisma client com a tipagem dos models do banco de dados, para isso execute o seguinte comando
$ yarn generate

# Execute a aplicação
$ yarn dev

O app estará rodando na porta 3333.
Acesse <http://localhost:3333>
Documentação <http://localhost:3333/api-docs>

⚖️ Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.