⚠️ DEPRECATED in favour of hyf-project-template

Meal sharing api

---

Website api for sharing meals together. Invite your best friends or your family for dinner!

📝 Table of Contents

• About
• Getting Started
• Usage
• Built Using
• Authors

🧐 About

Link to deployed website:

This project will be built out over 3 different classes:

• Nodejs week 3 - Here you will be building the backend api. Meaning you will work in the src/backend folder.
• React week 5 - Here you will be building the frontend components and routing. In this week you will be working in the src/client folder.
• Meal sharing class - After week 5 of react you will have a specific class for finishing the meal sharing website. Here you will make everything work and deploy the website to the internet

🏁 Getting Started

Environment variables

All sensitive data like fx passwords and usernames, we dont want to add to git! This problem we solve by having environment variables. Environment variables are not committed to git and have a key value structure.

Remember to copy the .env.example file, and rename the copied file to .env. In the .env file add the relevant host, database name, database user and pasword to your own local database. If you are unsure of these things then select your database in the Mysql Workbench. Now press Database -> Manage Connections.... Here you can see everything you need except the password. If you forgot that, reset it.

Prerequisites

• Postman
• MySQL Workbench

Installing

To install run npm install

🎈 Usage

To run npm run dev

The api can now be found on http://localhost:3000/api/ an example is http://localhost:3000/api/meals

⛏️ Built Using

• Mysql - Database
• Express - Server Framework
• NodeJs - Server Environment

☁️ Deployment

Deployment guide

✍️ Authors

• @benna100 - Idea & Initial work