ctfrancia / 21meals-server

21Meals is a meal planner and a shopping organizer that allows you to input your favorite recipes, arrange them through the week and have a customized grocery list based on your weekly plan.

21Meals is a meal planner and a shopping organizer that allows you to input your favorite recipes, arrange them through the week and have a customized grocery list based on your weekly plan.

For the client repo, please visit: 21Meals - client

Screenshots

Getting started

Prerequisites

• Node
• mySQL
• npm

Running the server

1. Clone the repo.

   $ git clone https://github.com/isadorabk/21meals-server.git  
   $ cd 21meals-server
   

2. Install dependancies

   $ npm install
   

3. Connect mySQL database

   In the terminal, run:

   $ mysql --password -u <your username>
   

   When prompted, enter your mySQL password.

   Now create a new database:

   $ CREATE DATABASE <database name>;
   

4. Set up your .env file

   Set up your .env file following the structure of the .env.example file

Usage

1. Start the server:

 $ cd 21meals-server  
 $ npm start

2. Postman collection

   Use the 21Meals.postman_collection.json to test all API endpoints.

3. Set up the front end

   Go to 21Meals - client and follow the instructions in the README.md file.

Tech Stack

Back-end built with:

• Koa
• mySQL
• Sequelize

Developers team

• Isadora Bassetto Kwiatkowski - GitHub - LinkedIn
• Jordi M. Zambrano - GitHub - LinkedIn
• Volodymyr Gromoglasov - GitHub - LinkedIn

License

This project is licensed under the MIT License.