Coder Social home page Coder Social logo

meal-picks-backend's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.