Skip to content

JoeDravarol/meal-picks-backend

Repository files navigation

Meal Picks Backend

Meal Picks Backend is an API server for recipe based projects. If you want to have an app or website with recipes, but don't want to spend a lot of time - this can be a good choice.

Table of contents

Endpoints

  • /api/recipes
  • /api/favoriteRecipes
  • /api/mealPlans
  • /api/users
  • /api/login

Technical Design

Meal Picks UML

The application is a simple CRUD system around recipes and meals. In the domain model, a recipe is a set of instructions for preparing a particular dish, including the list of ingredients required. A meal plan is a dish planned at a specified date.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

  1. Fork this repository on Github.
  2. Clone your forked repository onto your local computer.
  3. Use $ cd meal-picks-backend to move into the project directory.
  4. Create a .env file in the root directory and add the following as key = value shown in .env.example
  5. $ npm run dev to run a local development server.
  6. Explore and enjoy!

Built with

  • Mongoose
  • JsonWebToken
  • Bcrypt
  • Cloudinary
  • Multer
  • Continuous deployment with Cyclic
  • Prettier
  • ESlint
  • ReDoc

Contributors

  • Joe Lee - Initial work

License

This project is licensed under the MIT license - see the LICENSE file for details

Acknowledgement