Skip to content

README.md

Latest commit

 

History

History
110 lines (77 loc) · 2.46 KB

README.md

File metadata and controls

110 lines (77 loc) · 2.46 KB

🚗 Park and Ride Web

A modern web application for searching, booking, and managing park-and-ride rides. Built with React, Material UI, and Node.js.

✨ Features

  • 🔍 Search Rides: Find available rides between locations.
  • 🚘 Book Rides: Instantly book a ride with your preferred driver.
  • 📜 Ride History: View your past bookings and ride details.
  • 🛡️ Authentication: Secure login and user management.
  • 💬 Driver Ratings: See driver ratings and reviews.
  • 📱 Responsive Design: Works seamlessly on desktop and mobile.

🛠️ Tech Stack

  • Frontend: React, TypeScript, Material UI, Framer Motion
  • Backend: Node.js, Express
  • Database: MongoDB (or your choice)
  • APIs: RESTful endpoints

🚀 Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/Heman-dot/Park-Ride 
cd park-and-ride-web

  2. Install dependencies:

    cd client
npm install
cd ../server
npm install

  3. Set up environment variables:

    • Copy .env.example to .env in both client and server folders and fill in your configuration.

  4. Start the development servers:

    • Backend: 
      cd server
npm run dev
    • Frontend: 
      cd ../client
npm start

  5. Open your browser:

📂 Project Structure

park-and-ride-web/
├── client/      # React frontend
├── server/      # Node.js backend
├── README.md
└── ...

📝 API Endpoints

Method Endpoint Description
POST /api/rides/search Search for rides
POST /api/rides/book Book a ride
GET /api/rides/history Get ride history
... ... ...

🤝 Contributing

Contributions are welcome! Please open issues and submit pull requests.

📄 License

This project is licensed under the MIT License.

🙋‍♂️ Contact

For questions or support, please contact hemannarayanan@gmail.com.