CS164 LBA

An efficient and user-friendly application to plan your perfect day touring San Francisco’s top attractions. The app combines a smart backend API to optimize routes and a modern frontend interface for ease of use.

Features

• Curated SF Attractions: Explore iconic locations like Chinatown, Pier 39, and the Palace of Fine Arts.
• Smart Route Planning: Optimize your travel route with minimal time and maximum fun.
• Flexible Travel Options: Choose between driving, public transit, or walking.

---

Tech Stack

• Frontend: React (hosted on Vercel)
• Backend: Flask (hosted on Railway)

---

Installation and Local Setup

Prerequisites

• Node.js (for the frontend)
• Python 3.11+ (for the backend)
• Pip (Python package manager)

1. Clone the Repository

git clone https://github.com/Ifeoluwakolopin/lba.git
cd lba

2. Backend Setup

Install Dependencies:

pip install -r requirements.txt

Run Locally:

python api.py

Your Flask backend will start at http://127.0.0.1:5000.

---

3. Frontend Setup

Navigate to the optimal-route-app directory:

cd optimal-route-app

Install Dependencies:

npm install

Create an Environment File:

In the optimal-route-app directory, create a .env file with the following:

REACT_APP_API_BASE_URL=http://127.0.0.1:5000

Run Locally:

npm start

Your React app will start at http://localhost:3000.

---

4. Access the Application

• Open the frontend in your browser: http://localhost:3000.
• The frontend will make API calls to the Flask backend running at http://127.0.0.1:5000.

---

Contributing

We welcome contributions to enhance the app! Follow these steps to contribute:

1. Fork the Repository

Click the "Fork" button on the top-right corner of the repository.

2. Clone Your Fork

git clone https://github.com/your-username/sf-tour-planner.git
cd sf-tour-planner

3. Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

4. Make Changes

• Edit the code to add your feature or fix bugs.
• Ensure you write clear, readable, and well-documented code.

5. Test Your Changes

• Run the frontend and backend locally to ensure everything works as expected.

6. Commit and Push

git add .
git commit -m "Add your message here"
git push origin feature/your-feature-name

7. Create a Pull Request

• Go to the main repository on GitHub.
• Click "Pull Requests" > "New Pull Request".
• Select your branch and submit your PR with a clear description of your changes.