Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 3.2 KB

README.md

File metadata and controls

60 lines (43 loc) · 3.2 KB

foodprint header github

Foodprint is a platform where farmers/suppliers and restaurants find each other, and form more sustainable, direct local partnerships. As a result they cut the middleman – the big distribution- as well as that huge carbon footprint.
Restaurant users are also part of the equation, since by joining Foodprint, they can easily find sustainable restaurants in their area, and choose where to eat based on the restaurant's eco-scores.

Screenshots

image (3)

image (2)

image (1)

image

Getting started

Except for the regular suspects - git, Node, npm, etc - you need these things to run the Foodprint app. Follow the instructions supplied below them or on their links before you continue with Installation.

  • Mapbox. Get API key here
  • Google Places API. Get API key here
  • PostgreSQL local database, including the psql CLI. Download and install from here

Installation

  1. Clone this repo and enter!

    git clone https://github.com/frankperler/foodprint.git
cd foodprint

  2. Install dependencies, by running npm install both in the client and the server folder

  3. Add API keys as listed in the .env.example file.

  4. Start the server by running nodemon in the server folder.

  5. Create a database called "foodprint_dev" with PostgreSQL.

  6. For a better experience, you might want to populate your DB with mock data. To do so follow these steps:

    • In the server folder, find the "mock_data" folder
    • Open your psql CLI, paste and run the entire content of Logins.sql, Users.sql, Products.sql.
    • In server/index.js uncomment line 9 ("const populate = ...") and restart the server. Comment it back out.
    • Do the same for line 10.

  7. In the client folder, run npm start to start the development server.

Tech Stack

React, Typescript, Styled Components, PostgreSQL, Sequelize, Express.

Developers