<aside> 📜 TABLE OF CONTENTS

• Introduction
• Getting Started
• Management Methodology
• Git methodology
• API Documentation
• Database Schema
• Tech stack
• Dev plan
• meetings
• Third party code
• Stakeholder interactions
• Testing
• Security Audit
• App features
• User guide </aside>

Setup for local deployment 🎯

In this section, we'll guide you through the initial steps to deploy our app locally.

1 Clone the repository from GitHub

git clone <https://github.com/DolfShungube/Hiking-Logbook.git>

2. If you want to use the deployed API ignore the following two steps

3.a If you want to run the API locally go to the backend folder:

cd backend

b create a .env file ,(you will need the VITE_WEATHER_API_KEY , ,VITE_MAPBOX, the VITE_WEATHER_API_KEY, and VITE_SUPABASE_ANON_KEY used for the project)

install dependencies

npm install

start server

npm start

Go back to the root of the project

cd ..

3.a Go to the frontend folder

cd frontend

b create a .env file ,(you will need the VITE_SUPABASE_URL, VITE_MAPBOX, VITE_WEATHER_API_KEY and VITE_SUPABASE_ANON_KEY used for the project)

install dependencies

npm install

start app

npm run dev