marcosribeirodacunha / aurora-events-api

Backend da aplicação de divulgação de eventos utilizando Express, Typescript, TypeORM, Postgres e JWT.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Aurora Events

Aurora Events API

Aurora events é uma plataforma de divulgação de eventos onde é possivel publicar e descobrir novos eventos incríveis.

Linguagem mais usada Objetivo: estudo

Recursos   |    Instalação   |    Insomnia   |    Tecnologias   |    Licença

Recursos

  • 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

Instalação

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

Banco de dados

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

Executar a API

# Para executar a API em ambiente de desenvolvimento
$ npm run dev
// ou yarn dev

Insomnia

Para testar a aplicação utilizando o Insomnia clique no botão abaixo para criar um workspace com todas as rotas necessárias.

Run in Insomnia}

Tecnologias

Licença

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

About

Backend da aplicação de divulgação de eventos utilizando Express, Typescript, TypeORM, Postgres e JWT.

License:MIT License


Languages

Language:TypeScript 98.6%Language:Shell 1.1%Language:JavaScript 0.3%