Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.18 KB

README.md

File metadata and controls

83 lines (60 loc) · 3.18 KB

Project logo

Meal sharing

Status License


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

📝 Table of Contents

🧐 About

This project is an exercise for HackYourFuture students to learn the concepts of full stack development with a focus on the connection between:

Database <--> Webserver <--> Frontend

🏁 Getting Started

The homework for week4 should be made in a standalone repo on your github profile, so you can show it friends/new employeers/headhunters etc.

Here are the steps to do that:

  1. Create a new repository on your github profile.
  2. Clone that repository down locally.
  3. Copy the code for the template from the this folder into the newly created repo.
  4. Now copy last weeks server folder into the new repo in the src folder. You will now have a server folder and a client folder in the src folder.
  5. Uncomment the lines that is for week4!
  6. Add, commit and push the changes to your github.
  7. In the hyf-homework/node/week4 just add a text file with the link to the newly created repo.
  8. Thats it 🎉

Access server api

To access the server api, use localhost:3000/api

The traffic is being redirected (proxied) from localhiost:5000 where the server is running to localhost:3000/api. You can see that in the webpack.config.js file line 41.

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.

In the project there is a file called .env.example that has the correct structure. Copy this file and rename the copied file to .env. Now edit the credentials for your database.

The environment variables are then used in node using process.env.DB_HOST, you can see that in the src/serverdatabase.js file.

Prerequisites

Installing

To install run npm install

🎈 Usage

To run npm run dev

🚀 Deployment

Set Heroku with automated builds to the master branch. push your code to the master branch.

⛏️ Built Using

✍️ Authors