Skip to content

Latest commit

 

History

History
160 lines (126 loc) · 5.15 KB

README.md

File metadata and controls

160 lines (126 loc) · 5.15 KB
Raw

About RideShareX

Welcome to RideShareX! We've crafted this platform during our Unit 5 Construct Week, offering users the convenience of one-click cab bookings. Drawing inspiration from the user-friendly design of the Uber application, our goal is to provide an efficient and enjoyable experience.

Project Type

Fullstack

Deplolyed App

Frontend: Live Link

Backend: Live Link

Directory Structure

my-app/
├─ backend/
│  ├─ middlewares/
│  ├─ routes/
│  ├─ models/
│  ├─ node_modules/
│  ├─ .env/
│  ├─ .gitignore/
│  ├─ db.js/
│  ├─ index.js/
│  ├─ package.json/
├─ frontend/
│  ├─ images/
│  ├─ public/
│  ├─ scripts/
│  ├─ styles/
│  ├─ view/
├─ index.html/

Video Walkthrough of the project

Features

  • Developed a user-friendly website for cab ride reservations, improving the booking experience for users.
  • Implemented various features including user authentication, cab booking, ride tracking including admin panel.
  • Optimized server-side code and database queries to ensure efficient performance of the application.
  • Utilized HTML, CSS, and JavaScript to create an attractive and responsive user interface.
  • Built backend server using Node.js and Express framework to handle user requests and authenticate users.

Design Decisions or Assumptions

  • Utilized Bootstrap for responsive design to ensure compatibility across devices.
  • Implemented MongoDB as the database for scalability and flexibility.
  • Chose Express.js for the backend framework due to its simplicity and robustness.

Installation & Getting started

Detailed instructions on how to install, configure, and get the project running.

git clone https://github.com/your-username/speedster.git

Install dependencies:

cd speedster
npm install

Set up environment variables:

cp .env.example .env

Start the server:

npm run server

Credentials

Demo User(Rider):

  • Username: rider
  • Password: 1234

Demo User(Driver):

  • Username: driver
  • Password: 1234

Demo User(Admin):

  • Username: demo
  • Password: 1234

Usage

How to use our project:

# Example
To book a cab(user view):
1. log in or register using user crediential.
2. after login select start and destination location.
3. then select ride whichever you want.
4. and request a cab.

To accept ride request (driver view):
1. log in or register using driver crediential.
2. after login select toggle the status available or not.
3. after toggling available driver will get the request , then he can accept request from rider.
4. and request a cab.

Screenshots

Home Page

Home Page

Driver Page

Driver Page

Blog Page

Blog Page

Rider Page

Rider Page

Footer Page

Footer Page

Responsiveness

Our website, RideShareX, is designed with responsiveness in mind to provide a seamless experience across various screen sizes and devices. We have utilized responsive design techniques, including flexible grid layouts and media queries, to ensure that the content adapts appropriately to different screen resolutions.

Responsiveness

Tech Stack

  • HTML
  • CSS
  • JavaScript
  • Node.js
  • Express
  • MongoDB

Team Members

API Documentation

For detailed information on using our API, including available endpoints and any required authentication, refer to our - Swagger Document.

Contribution Guidelines

We welcome contributions from the community! If you'd like to contribute to RideShareX, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/new-feature.
  3. Make your changes and commit them: git commit -m 'Add new feature'.
  4. Push to the branch: git push origin feature/new-feature.
  5. Submit a pull request.

Please ensure your code adheres to our coding standards and includes tests when applicable.

License

RideShareX is licensed under the MIT License. See the LICENSE file for details.

Feel free to reach out if you have any questions or need further assistance. Happy coding!