Aurora events é uma plataforma de divulgação de eventos onde é possivel publicar e descobrir novos eventos incríveis.
Recursos | Instalação | Insomnia | Tecnologias | Licença
- Cadastro, listagem e deleção de usuários
- Atualização de avatar do usuário
- Criação de sessão com JWT
- Criação, listagem e deleção de eventos
- Atualização de dados e foto dos eventos
- Like e Dislike em eventos
Para clonar e executar esta aplicação é necessário possuir instalado Git e NodeJS (que instala também o npm). Em sua linha de comando:
# Clone o repositório
$ git clone https://github.com/marcosribeirodacunha/aurora-events-api.git
# Entre no repositório
$ cd aurora-api
# Instale as dependências
$ npm install
// ou yarn
Esta aplicação utiliza como banco de dados o Postgres em um container do Docker. Entretanto é possivel utilizar o banco instalado localmente.
Antes de realizar as migrations realize os seguintes passos:
- Renomeie o arquivo
.env.example
para.env
- Altere as variáveis faltantes de acordo com os dados do banco de dados postgreSQL no qual utilizará
- Crie um banco de dados com o mesmo nome daquele contido na variável
TYPEORM_DATABASE
do arquivo.env
; - Verifique se o banco de dados criado possui a extensão
uuid-ossp
habilitada. Caso não possua, habilite esta extensão.
Após verificar os passos anteriores execute os seguintes comandos:
# Executa as migrations
$ npm run typeorm migration:run
// ou yarn typeorm migration:run
# Para executar a API em ambiente de desenvolvimento
$ npm run dev
// ou yarn dev
Para testar a aplicação utilizando o Insomnia clique no botão abaixo para criar um workspace com todas as rotas necessárias.
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.