/CFM_Frontend

Primary LanguageJavaScriptMIT LicenseMIT

Fridge Finder

GitHub contributors Build Status

A community fridge is a decentralized resource where businesses and individuals can donate perishable food. There are dozens of fridges hosted by volunteers across the country. The Fridge Finder website is available at fridgefinder.app

Fridge Finder is a project sponsored by Collective Focus, a community organization in Brooklyn, New York. Our goal is to make it easy for people to find fridge locations and get involved with food donation programs in their community. We are building a responsive, mobile first, multi-lingual web application with administrative controls for fridge maintainers. To join the project read our contributing guidelines and code of conduct.

Made possible by contributions from these lovely people …

❤ Thank you for all your hard work

System Requirements

  1. Node

System Setup

  1. Verify your system meets the requirements

    node --version  # must be greater than 14.6.0
  2. Install global dependencies

    npm install --global yarn prettier svgo lint-staged concurrently json-server
    corepack enable # for yarn
  3. Setup the frontend environment

    git clone https://github.com/CollectiveFocus/CFM_Frontend frontend
    cd frontend
    git checkout dev
    yarn install
  4. Run the unit tests

    yarn test
  5. Run the application locally

    # to run both development database and Next.js web server
    yarn dev
    
    # to run only the web server
    yarn web
    
    # to run only the development database
    yarn data

    in a different terminal window

    start   "Google Chrome" http://localhost:3000/ # Windows
    open -a "Google Chrome" http://localhost:3000/ # MacOS