nizolnier / cookenu

A REST API for creating recipes and making friends

Cookenu 🍳

English | Português

Back-end project developed in Labenu's bootcamp
Cookenu is a REST API to create recipes and make friends! 👩‍🍳

• 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

✦ Features

• Sign up
• Login
• Follow user
• Unfollow user
• Reset password
• Get all users
• Get your own profile
• Get another user's profile
• Delete user
• Publish a recipe
• Get all recipes
• Get a specific recipe

✦ Libraries and Frameworks:

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

Developed with 🧡 by Nicole Zolnier

---

English | Português

Projeto back-end desenvolvido no bootcamp da Labenu.
Cookenu é uma API REST para criar receitas e fazer amigos! 👩‍🍳

• 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

✦ Funcionalidades:

• Cadastro
• Login
• Seguir usuário
• Deixar de seguir usuário
• Resetar senha
• Ver todos os usuários
• Ver seu próprio perfil
• Ver perfil de outro usuário
• Deletar Usuário
• Publicar uma receita
• Ver feed de receitas
• Ver uma receita em específico

✦ Bibliotecas e Frameworks:

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

Desenvolvido com 🧡 por Nicole Zolnier