README.md

Dequa

API desenvolvida durante a segunda fase do Ioasys Camp - Trilha Backend

Você já reparou em quantas pessoas com deficiência convivem ou já conviveram com você?

Objetivo • Tecnologias • Utilizar • Documentação • Autor • Licensa

🎯 Objetivo

O objetivo do Dequa é facilitar a presença de PCD's ( Pessoas com Deficiências ) no mercado de trabalho por meio de vagas personalizadas, acesso fácil á educação e sensação de inclusão e pertencimento.

🛠 Tecnologias

As seguintes tecnologias foram utilizadas neste projeto:

• TypeScript
• NodeJS
• Postgres
• Typeorm
• AWS
• Docker
• Docker Compose
• Yarn
• ESlint
• Prettier

📕 Utilizar

## Clone o repositório do projeto 
$ git clone https://github.com/joaopedrobuzattim/dequa.git

## Entre na pasta criada 
$ cd dequa

## Instale as dependencias do projeto com o yarn ou com o npm
$ yarn
## Ou
$ npm install

## Rode o comando do Docker Compose para criar o container do Postgres
$ docker-compose up -d

## Crie um arquivo .env contendo as informações presentes em .env.example
$ touch .env

## Em um editor SQL de sua preferência, crie a database dequa
CREATE DATABASE dequa;

## Rode as migrations
$ yarn typeorm migration:run 

## Rode o comando de seed para criar o usuario admin 
## email: [email protected]
## password: admin
$ yarn seed:run

## Inicie a aplicação
$ yarn dev:server

## Aplicação rodando

📋 Documentação

Esta API foi documentada com Postman

• Link: Documentação da API

Autor

_{João Pedro Buzatti Mendes}

Entre em contato!

License

This project is MIT licensed.