sineadmccaffery/final-project-snack-match

SnackMatch: A web app that helps groups of friends or colleagues easily find a restaurant that everyone will enjoy.

mern-tailwind-vivid-starter

A repository of Snackmatch App files

Getting Started

This repository contains both an Express backend (within api) and a React frontend (within client). To get started, clone the repository. Navigate to your terminal and execute the following command.

git clone https://github.com/vivid-labs/mern-tailwind-vivid-starter.git

In order to have a fully functional web app, you'll need to run both the frontend and the backend simultaneously.

Starting the frontend

From the root of the repository, you'll need to enter the client folder, install the necessary dependencies, and run the app.

cd client
#If you don't already have yarn
npm install --global yarn
yarn install
yarn start

Navigate to localhost:3000 to see the running app. You'll notice that the Express status will state "Currently down." It will remain that way until you start the backend.

Starting the backend

From the root of the repository, you'll need to enter the api folder, install the necessary dependencies, and run the server.

cd api
yarn install
yarn start

Navigate to localhost:9000/testAPI to see the results of the /testAPI route. If you refresh your localhost:3000 tab, your Express status should change.

Styling with Vivid

Vivid lets you style with Tailwind in your browser. Cmd-Click (Windows: Ctrl) on any component to see its code. Check out Vivid's docs for a guide to its full functionality.