nizolnier / lama

A REST API to manage Labenu Music Awards

Labenu Music Awards 🏆

English | Português

Back-end project developed in Labenu's bootcamp
LAMA is a REST API to manage the Labenu Music Awards, a festival with several bands for my class graduation! 📻

• Documentation
• Getting Started
• Available Scripts
• Features
• Libraries and Frameworks

✦ Documentation

• Postman
• Endpoints

✦ Getting Started

1- clone this repository

2- run this command

npm install

3- create .env file on the root directory of the project with this data:

// your database

DB_HOST =
DB_USER =
DB_PASSWORD = 
DB_DATABASE_NAME = 

//your key and time expire preferences

JWT_KEY =
JWT_EXPIRES_IN = 

//your cost preference

BCRYPT_COST = 

4- run this command

npm run setup

5- now this one

npm start

6- YOU'RE ICE CREAM IS READY!!!

✦ Available Scripts

• npm run setup to create tables
• npm run start to run the application
• npm run dev to run the application with hot reload
• npm run test to test the application

✦ Features

• Sign up
• Login
• Register a band
• Create a show
• Search for a band by its id or name
• Ver os shows de determinado dia

✦ Libraries and Frameworks:

• cors
• express
• knex
• mysql
• dotenv
• uuid
• jsonwebtoken
• bcryptjs
• jest

Developed with 💜 by Nicole Zolnier

---

English | Português

Projeto back-end desenvolvido no bootcamp da Labenu.
LAMA é uma API REST para gerenciar o Labenu Music Awards, um festival com várias bandas para a formatura da minha turma! 📻

• Documentação
• Primeiros Passos
• Scripts Disponíveis
• Funcionalidades
• Bibliotecas e Frameworks

✦ Documentação

• Postman
• Endpoints

✦ Primeiros Passos

1- clone ese repositório

2- rode o comando abaixo

npm install

3- crie um arquivo .env na raíz do projeto com esses dados:

//dados do seu banco

DB_HOST =
DB_USER =
DB_PASSWORD = 
DB_DATABASE_NAME = 

//suas preferências para key e expire

JWT_KEY =
JWT_EXPIRES_IN = 

//suas preferências de cost

BCRYPT_COST = 

4- rode esse comando:

npm run setup

5- agora esse

npm start

6- TÁ PRONTO O SORVETINHOOOOO!

✦ Scripts Disponíveis:

• npm run setup para criar as tabelas
• npm run start para rodar a aplicação
• npm run dev para iniciar a aplicação com hot reload
• npm run test para testar a aplicação

✦ Funcionalidades:

• Cadastro
• Login
• Registrar uma banda
• Criar um show
• Procurar por uma banda com base no id ou nome
• Ver os shows de determinado dia

✦ Bibliotecas e Frameworks:

• cors
• express
• knex
• mysql
• dotenv
• uuid
• jsonwebtoken
• bcryptjs
• jest

Desenvolvido com 💜 por Nicole Zolnier