gabrielfray / vibefy-back-end

Vibefy documentation API

Tabela de Conteúdos

1. Sobre
2. Links Relevantes
3. Techs
4. Instalação
5. Desenvolvedores
6. Termos de uso

---

1. Sobre

• Já se pegou perdendo tempo procurando músicas e montando playlists que se encaixem no seu perfil?
• O vibefy foi projetado por pessoas que assim como você cansaram de perder tempo pesquisando músicas ou montando playlists só para no fim acabar usando umas 5 ou 6 músicas em uma corrida matinal, ou em outras tarefas onde apenas procuramos músicas para não deixar aquele silêncio absoluto (codar é um desses exemplos), No vibefy você vai poder abrir o site ou o aplicativo e estar ouvindo a "Vibe" que desejar em menos de 2 minutos.
• O projeto funciona da seguinte forma, o usuário se cadastra, e após estar cadastrado ele terá acesso a todas as playlists montadas pela nossa curadoria, o usuário poderá digitar a vibe que deseja no campo de buscas e retornaremos as playlists mais indicadas para ele, ai é só clicar e curtir, caso goste muito ele ainda poderá adicionar às suas playlists favoritas e tocá-las com apenas um clique.
• Possuímos uma área exclusiva para artistas poderem divulgar suas musicas, mas claro terá que passar pela nossa curadoria para que encaixemos nas playlists que combinam com a "vibe" da musica, claro a opinião do artista também tem peso na decisão.
• O projeto conta com playlists excluivas para músicas sem direitos autorais, para aqueles usuários que necessitam de músicas de fundo para seus pitch, videos, livestream e etc...
• Em resumo somos um projeto de soluções músicais para otimizar seu tempo e agregar felicidade em suas necessidades do dia a dia.

2. Links relevantes

• Link da aplicação

• Documentação API

• Diagrama ER da API definindo bem as relações entre as tabelas do banco de dados.

3. Techs

Visão Geral das tecnologias usadas no projeto.

• NodeJS
• Express
• TypeScript
• PostgreSQL
• TypeORM
• Yup
• Docker
• Aws-sdk
• Bcryptjs
• Nodemailer
• Multer-s3
• uuid-validate
• swager
• reflect-metadata
• pg
• jsonwebtoken
• express-async-errors
• dotenv
• cross-env
• class-transformer

---

---

4. Instalação e uso

4.1 Requisitos:

• NodeJs a partir da versão 16.14.1
• Gerenciador de pacotes yarn ou npm
• Banco de dados PostgreSQL

4.2 Instalação

4.2.1 - Crie um banco de dados chamado vibe_database no PostgreSQL 4.2.2 - Após o clone no repositório para adicionar todas as dependências do package json execute o comando: yarn install

4.2.3 - Crie um arquivo na raiz do projeto chamado .env e faça as configurações das variáveis de ambiente com base no .env.example do projeto

SECRET_KEY= chave secreta definida pelo seu time de desenvolvimento
DATABASE_URL=postgresql://seu_usuario:sua_senha@localhost:5432/vibe_database
ADM_HASH= hash de administrador definida pela equipe de desenvolvimento
AWS_ACCESS_KEY_ID= id de acesso da aws para salvar seus arquivos
AWS_SECRET_ACCESS_KEY= chave de acesso da aws para salvar seus arquivos

4.2.4 - Para rodar projeto utilize o comando yarn dev no terminal, caso de tudo certo receberá uma mensagem parecida com essa:

[INFO] 17:23:18 ts-node-dev ver. 2.0.0 (using ts-node ver. 10.9.1, typescript ver. 4.8.4)
query: SELECT * FROM current_schema()
query: CREATE EXTENSION IF NOT EXISTS "uuid-ossp"
query: SELECT version();
Servidor executando.

5. Desenvolvedores

Voltar para o topo

• Gabriel Fernandes
• Gabriel Fray
• Guilherme Teles
• Henrique Pires Bezerra
• Victor Ávila
• Vinicius Moreira Henrique

6. Termos de uso

Este é um projeto Open Source para fins educacionais e não comerciais, Tipo de licença - MIT