phsarah / cookenu

A REST API for create recipes and meeting food-loving people.

Cookenu 🥘

English | Português

Back-end project developed in Labenu's bootcamp.
Cookenu is a REST API for create recipes and meeting food-loving people! 👩‍🍳

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

📙 Documentation

Here Postman. 🍊

🚀 Getting Started

At the terminal,

1- Clone this repository

git clone https://github.com/phsarah/cookenu.git

2- Install the dependencies

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 little commander (I promise it's the last one)

npm start

6- Next step ... i'm kidding, let's go to the code! 🦄

🔸 Available Scripts:

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

🔸 Features

• Log in
• Sign up user roles and cryptography
• Get your own profile data through the token
• Get data from another user's profile through the Id
• Create recipes
• Get recipes by id
• Follow user
• Unfollow user
• Show recipe feed

🛠 Libraries and Frameworks:

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

Thank you for your visit and good coding!

Developed with 💖 by Sarah Hessel

---

English | Português

Projeto back-end desenvolvido no bootcamp da Labenu.
Cookenu é uma API REST para criar receitas e conhecer pessoas que gostam de comida! 👩‍🍳

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

📙 Documentação

Aqui Postman. 🍊

🚀 Primeiros Passos

No terminal,

1- Clone este repositório

git clone https://github.com/phsarah/cookenu.git

2- Instale as dependências

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 comandinho (prometo que é o ultimo)

npm start

6- Proximo passo... brincadeirinha, bora pro código! 🦄

♠️ 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

♠️ Funcionalidades:

• Login
• Cadastro com user roles e criptografia
• Pegar dados do próprio perfil através do token
• Pegar dados do perfil de outro usuário através do Id
• Criar receitas
• Pegar receitas pelo id
• Seguir usuário (follow)
• Deixar de seguir usuário (unfollow)
• Mostrar feed de receitas

🛠 Bibliotecas e Frameworks:

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

Obrigada pela visita e boa codificação!

Desenvolvido com 💖 por Sarah Hessel