thalysonalexr / think-music

:musical_note: Simples API de músicas, interpretações, autores e comentários construída com NodeJS, Express, Sequelize/Postgres, JWT, Nodemailer e testada com Jest.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

think-music

GitHub version Software License contributions welcome Open Source Love

Simples API para integração de aplicações que desejarem aderir a esta ideia.

logo

O que seria isso?

Esta é uma API construída com Node.js e Express para estudar conceitos de ORM com Sequelize e um compilado de outros conhecimentos. Esta é uma simples ideia de serviço Web para manipulação de interpretações sobre músicas.

🚀 Tecnologias

  • express
  • postgres
  • sequelize
  • nodemailer
  • jsonwebtoken
  • jest

Contribuir

Passo 1: de um fork neste repositório e em seguida faça o clone

git clone https://github.com/<yourusername>/think-music

Passo 2: configure as variáveis de ambiente. Por padrão deixei um arquivo de exemplo .env.example. Devem ser configurados para api (./api/.env.example) e para os containers do Docker (./.env.example).

Passo 3: instale as dependências do projeto (yarn)

cd api/
yarn install

Passo 4: utilize docker e docker compose para subir os containers da aplicação

# subir os containers
docker-compose up
# verificar os processos
docker ps

Passo 5: teste com Jest (100% coverage)

yarn test

Passo 6: crie novas features... (desenvolva muitoooooo)

git checkot -b add-<feature-name>

Passo 6: push e realize um pull request para o repositório original

Surgimento da ideia

Uma das coisas que amo na vida é música. Muitas das músicas que escuto suas letras transmitem essencialmente algo que passou em minha vida, e é claro, vem de uma interpretação intrínseca. Bom, desenvolvi esta API para colocar em prática uma ideia que tive há um tempo: "uma plataforma, site ou aplicativo em que eu pudesse compartilhar com outras pessoas o que entendo sobre algumas músicas e agregar novos pensamentos de outras pessoas, pois uma interpretação não tem certo ou errado e talvez não precise fazer sentido"; também compilar alguns conhecimentos adquiridos recentemente sobre algumas tecnologias em JS. Se você é um desenvolvedor frontend, sinta-se a vontade para criar aplicações para consumir esta API e fornecer ao usuário uma experiência que eu e outras pessoas provavelmente gostariam. Qualquer dúvida entre em contato, novas ideias para este projeto faça um pull request. A comunidade é aberta, seja um colaborador e de antemão, seja bem-vindo.

Teste os Endpoints da API com Insomnia

Run in Insomnia}


Créditos

Construído com ♥ por Thalyson Rodrigues

About

:musical_note: Simples API de músicas, interpretações, autores e comentários construída com NodeJS, Express, Sequelize/Postgres, JWT, Nodemailer e testada com Jest.

License:MIT License


Languages

Language:JavaScript 99.7%Language:HTML 0.2%Language:Dockerfile 0.1%