Lo-Fi Radio

Simples aplicação de streaming de Lo-Fi Hip-Hop.

API » | Trello »

Tabela de Conteúdos

• Sobre o Projeto
• Rotas
• Tecnologias
• Instalação e configuração
  • Requisitos
  • Opcional
  • Instalação
• Licença

Sobre o Projeto

• A fazer

Rotas

Informações básicas sobre as rotas da aplicação.

HTTP	Rota	Descrição	Autenticação
GET	/artists	retorna uma lista de artistas	não
POST	/artists	registra um artista	sim
PATCH	/artists/:uuid	atualiza artistas	sim
DELETE	/artists/:uuid	deleta um artistas	sim
POST	/artists/:uuid/upload	upload dos arquivos de artistas	sim
GET	/songs	retorna uma lista de músicas	não
POST	/songs	registra uma música	sim
PATCH	/songs/:uuid	atualiza uma música	sim
DELETE	/songs/:uuid	deleta uma música	sim
POST	/songs/:uuid/upload	upload dos arquivos de músicas	sim
GET	/playlists	retorna uma lista de playlists	não
POST	/playlists	registra uma playlists	sim
PATCH	/playlists/:uuid	atualiza uma playlists	sim
DELETE	/playlists/:uuid	deleta uma playlists	sim
GET	/docs	documentação da API	não

Tecnologias

Este projeto foi construído com as seguintes tecnologias:

• Node.js »
• Express.js »
• Typescript »
• Jest »
• GitHub Actions »
• Swagger »
• TypeORM »
• Azure Storage »

Instalação e configuração

Requisitos

• Node.js » na sua versão lts
• Um Banco de dados MySQL »

Opcional

• Conta na plataforma Codecov »
• Uma SAS Key » do Azure Storage.

Instalação

1. Clone o projeto: git clone https://github.com/JorgeLNJunior/lofi-radio-api.git
2. Instale as dependências: npm i
3. Renomeie o arquivo .env.example para .env
4. Execute as migrations com o comando npm run typeorm migration:run
5. Execute o comando npm run seed:run para popular o banco de dados
6. Para iniciar a aplicação execute npm start:dev, para os testes execute npm test

Licença

Projeto sob a licença MIT »