AVu120/tree-match

An app that tells you what kind of tree you should plant in your garden. Demo: https://tree-match.herokuapp.com/

TreeMatch

A service that tells you what kind of tree you should plant in your garden! It guides users through a questionnaire and matches them with a tree species.

Play with this app at https://tree-match.herokuapp.com/.

Table of Contents

• Built With
• Prerequisites
• How to Build the App
• How to Run the App
• How to Test the App
  

Built With

• React
• Node with npm included.
• Express
  

Getting Started

1. Clone the project source code.

git clone https://github.com/AVu120/tree-match.git

2. Navigate into the project directory.

cd tree-match

How to Build & Run the App Locally

1. Ensure you're on the main or dev branch.

git checkout main

OR

git checkout dev

2. Start the frontend running on a webpack dev server.

cd client
npm i
npm start

3. Start the backend/api-server.

cd ../server
npm i
npm start

4. Access the app in any web browser via localhost:3000.

How to Deploy the App

1. In the root directory (/tree-match), ensure you're on the deployment branch.

git checkout deployment

2. Run the build script.

npm run build

3. Run the deploy script.

npm start

4. Access the app in any web browser via localhost:5000

How to Test the App

Test the frontend:

cd client
npm test

Test the backend:

cd ../server
npm test