README.md

CommuteSmartAI 🚍

CommuteSmartAI is a modern, full-stack web application that aims to optimize and visualize the public transportation experience of New York City. This is accomplished by using real-time transit data and intelligent route suggestions.

Built with a React + TypeScript Frontend, a Go Fiber Backend, and various API integrations, the app aims to offer a fast, reliable, and intuitive experience for computers.

---

Table of Contents

• CommuteSmartAI 🚍
  • Table of Contents
  • Tech Stack 📦
  • Project Structure 🚧
  • Documentation
  • Getting Started 🛠️
    • Clone Repo
    • Set up the frontend
    • Set up the backend
  • Development Checklist
  • License 🪪
  • Acknowledgements 🙌🏼

---

Tech Stack 📦

Layer	Tech
Frontend	React, TypeScript, Tailwind CSS, Vite
Backend	Go (Fiber framework)
APIs	Google Maps, ...
Hosting	Vercel (Frontend), Render (Backend)
Auth	OAuth
DB	MongoDB

---

Project Structure 🚧

CommuteSmartAI/

|---- .github/workflows/ # GitHub Actions .yml files

|---- backend/ # Go Fiber backend

|---- frontend/ # React frontend

|---- /docs # Architecture, setup guides, etc.

---

Documentation

• docs/README.md - Full developer guide
• `docs/architecture.md - System design
• `docs/api-integrations.md External API usage

---

Getting Started 🛠️

Clone Repo

git clone https://github.com/JahleelT/CommuteSmartAI.git
cd CommuteSmartAI

Set up the frontend

cd frontend
npm install
npm run dev

Set up the backend

cd backend
go run main.go

---

Development Checklist

• Set up API integrations
• Implement auth system
• Define commute optimization logic
• Add user profile features
• Connect frontend with backend
• Add CI/CD workflows
• ...

See docs/CHECKLIST.md for complete WIP list.

---

License 🪪

This project is under the MIT License

---

Acknowledgements 🙌🏼

• Google Maps Platform
• MTA Developers
• Fiber by Go
• Vite + React Community
• ...

---