Giter VIP home page Giter VIP logo

gauravrupamrai / carpooling Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 211 KB

CarPooling by RideTogether: A web-based carpooling platform built on AWS. Streamlines connections between drivers & passengers with React frontend & serverless backend. Developed during a cloud computing course.

Home Page: http://carpoooling-webapplication.s3-website-eu-west-1.amazonaws.com/

HTML 5.29% JavaScript 91.74% CSS 2.97%
api-gateway aws carpooling cloud-computing cloudwatch dynamodb iam lambda-functions reactjs s3-bucket serverless web-application

carpooling's Introduction

RideTogether Inc. - CarPooling ๐Ÿš—

CarPooling is a web-based application developed as part of the Cloud Computing project to showcase the utilization of various AWS cloud services for hosting and managing a web application.

๐ŸŒ Table of Contents

๐Ÿ“œ Overview

CarPooling is designed to bridge the gap between drivers and co-passengers, offering a platform where they can register, search, and book car rides seamlessly. With its modern web technologies and serverless architecture on AWS, CarPooling ensures a scalable, reliable, and secure user experience.

๐Ÿ— Architecture

Frontend

  • Framework: React.js
  • Hosting: Amazon S3 bucket, ensuring a scalable and cost-effective solution for hosting static files.

Backend

  • Serverless Architecture: Provides flexibility and scalability, eliminating the need for traditional server-based setups.
  • API Gateway: Manages and routes API calls from the frontend to the backend.
  • Lambda Functions: Processes API calls and interacts with the database.
  • DynamoDB: A NoSQL database service, perfect for storing unstructured data like car registration and booking details.
  • CloudWatch: Monitors and logs backend activities, offering insights and troubleshooting capabilities.
  • IAM (Identity and Access Management): Ensures security by creating users with limited access and defining policies for resource interactions.

Architecture Diagram

๐Ÿš€ Functionalities

Register a Car

Drivers can offer their cars for carpooling by:

  • Filling out a registration form with car details.
  • Submitting the form, which triggers an API Gateway endpoint.
  • Data is validated and stored in DynamoDB.
  • Upon successful registration, drivers receive a confirmation message.

Car Registration Flow

Search for a Car

Prospective co-passengers can:

  • Input search criteria on the application's search page.
  • View matching car details based on their search parameters.

Search Car Flow

Book a Car

Users can:

  • Select a car from the search results.
  • Provide booking details and submit.
  • Receive a confirmation message upon successful booking.

Book Car Flow

๐Ÿ“‚ Repository Structure

  • frontendcarpool: Contains all frontend-related files and configurations.
  • service: Houses customer.js and driver.js for handling different service requirements.
  • utils: Utility functions and helpers.
  • index.js: Main entry point for the Lambda microservice.

๐Ÿš€ Getting Started

Detailed setup and deployment instructions will be provided soon. Stay tuned!

Live Demo

Experience the RideTogether Inc. website live here.

Contributing

Contributions to the RideTogether Inc. project are welcome. To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-new-feature
  3. Make changes and commit them: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

The RideTogether Inc. project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

The RideTogether Inc. project was created as part of a cloud computing course. Thanks to the course instructors and fellow students for their support and feedback.

carpooling's People

Contributors

gauravrupamrai avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.