Skip to content

agusscript/terrand-challenge-api

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

Recipe App API

Terrand Full-Stack challenge.

Prerequisites (important)

  • Node >= 20 | This project was developed using node version 20.18.3
  • Docker | You will need to have Docker installed to be able to launch the database (MySQL).

Project setup

$ npm install

Environment variables

NODE_ENV= PORT= DB_HOST= DB_PORT= DB_USER= DB_PASSWORD= DB_ROOT_PASSWORD= DB_NAME= GLOBAL_PREFIX= JWT_SECRET=

Run the Docker image with the DB

$ docker compose up -d

Compile and run the project

# development $ npm run start # watch mode $ npm run start:dev

About the challenge

Create an app where users can register and share recipes.

Mandatory functional requirements completed

  • Registration with​ Name, Last Name, Email, Password, and Repeat Password.
  • Login with​ Email and Password.
  • Private section to see all my recipes, edit and create a new one.
  • A recipe must have at least: Title, Description, Ingredients.
  • The application must generate a public link where the recipe can be seen.

Optional functional requirements completed

  • Allow logged-in users to rate recipes.
  • Allow each recipe to upload an image.
  • Publish your application (Deploy).

Technical requirement completed

  • Use any JavaScript technology.

Extras

Aditional information.

Entity Relationship Diagram

Endpoints

Authentication

- POST /auth/sign-up - POST /auth/sign-in 

Recipe

- GET /recipe - GET /recipe/:id - GET /recipe/mine - POST /recipe - PATCH /recipe/:id - DELETE /recipe/:id 

About

Full-Stack challenge (API) - Recipes App

Topics

Resources

Stars

Watchers

Forks