Uber Clone Project

Overview

This project is a clone of the Uber application, built to demonstrate a full-stack application with a focus on backend services and frontend integration. The project includes features such as address geocoding, distance and time calculation, autocomplete suggestions, and finding captains within a radius.

12deb048-d4e1-469f-89a8-1514d68a0fc5.mov

Libraries and Technologies Used

Backend

• Node.js: JavaScript runtime for building server-side applications.
• Express.js: Web framework for Node.js.
• Axios: Promise-based HTTP client for making API requests.
• Mongoose: MongoDB object modeling tool.
• dotenv: Module to load environment variables from a .env file.

Frontend

• React.js: JavaScript library for building user interfaces.
• Redux: State management library for JavaScript apps.
• Axios: Promise-based HTTP client for making API requests.

Environment Variables

Create a .env file in the root directory of the project and add the following environment variables:

MAPMYINDIA_API_KEY=your_mapmyindia_api_key
MONGODB_URI=your_mongodb_connection_string
PORT=your_server_port

Backend Services and Routes

Map Routes

Address Geocoding

Endpoint: /api/maps/address-coordinate
Method: POST
Description: Get the latitude and longitude of a given address.
Request Body:

{
  "address": "string"
}

Response:

{
  "ltd": "number",
  "lng": "number"
}

Example:

curl -X POST http://localhost:your_server_port/api/maps/address-coordinate -H "Content-Type: application/json" -d '{"address": "1600 Amphitheatre Parkway, Mountain View, CA"}'

Distance and Time Calculation

Endpoint: /api/maps/distance-time
Method: POST
Description: Calculate the distance and estimated time between two locations.
Request Body:

{
  "origin": "string",
  "destination": "string"
}

Response:

{
  "distance": "number",
  "duration": "number",
  "originCoord": {
    "ltd": "number",
    "lng": "number"
  },
  "destinationCoord": {
    "ltd": "number",
    "lng": "number"
  }
}

Example:

curl -X POST http://localhost:your_server_port/api/maps/distance-time -H "Content-Type: application/json" -d '{"origin": "New York, NY", "destination": "Los Angeles, CA"}'

Autocomplete Suggestions

Endpoint: /api/maps/autocomplete
Method: POST
Description: Get autocomplete suggestions for a given input.
Request Body:

{
  "input": "string"
}

Response:

["string"]

Example:

curl -X POST http://localhost:your_server_port/api/maps/autocomplete -H "Content-Type: application/json" -d '{"input": "Bhandup"}'

Captains in the Radius

Endpoint: /api/maps/captains-in-radius
Method: POST
Description: Find captains within a specified radius from a given location.
Request Body:

{
  "ltd": "number",
  "lng": "number",
  "radius": "number"
}

Response:

[
  {
    "id": "string",
    "name": "string",
    "location": {
      "ltd": "number",
      "lng": "number"
    }
  }
]

Example:

curl -X POST http://localhost:your_server_port/api/maps/captains-in-radius -H "Content-Type: application/json" -d '{"ltd": 19.2183, "lng": 72.9781, "radius": 5}'

User Routes

User Registration

Endpoint: /api/users/register
Method: POST
Description: Register a new user.
Request Body:

{
  "name": "string",
  "email": "string",
  "password": "string"
}

Response:

{
  "id": "string",
  "name": "string",
  "email": "string"
}

User Login

Endpoint: /api/users/login
Method: POST
Description: Authenticate a user and return a token.
Request Body:

{
  "email": "string",
  "password": "string"
}

Response:

{
  "token": "string"
}

Captain Routes

Captain Registration

Endpoint: /api/captains/register
Method: POST
Description: Register a new captain.
Request Body:

{
  "name": "string",
  "email": "string",
  "password": "string",
  "vehicle": "string"
}

Response:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "vehicle": "string"
}

Captain Login

Endpoint: /api/captains/login
Method: POST
Description: Authenticate a captain and return a token.
Request Body:

{
  "email": "string",
  "password": "string"
}

Response:

{
  "token": "string"
}

Ride Routes

Create Ride

Endpoint: /api/rides
Method: POST
Description: Create a new ride.
Request Body:

{
  "userId": "string",
  "captainId": "string",
  "origin": "string",
  "destination": "string",
  "fare": "number"
}

Response:

{
  "id": "string",
  "userId": "string",
  "captainId": "string",
  "origin": "string",
  "destination": "string",
  "fare": "number",
  "status": "string"
}

Get Ride Details

Endpoint: /api/rides/:id
Method: GET
Description: Get details of a specific ride.
Response:

{
  "id": "string",
  "userId": "string",
  "captainId": "string",
  "origin": "string",
  "destination": "string",
  "fare": "number",
  "status": "string"
}

How to Run the Project

1. Clone the repository:

   git clone https://github.com/yourusername/uber-clone.git

2. Navigate to the project directory:

   cd uber-clone

3. Install the dependencies for both backend and frontend:

   npm install
   cd frontend
   npm install
   cd ..

4. Create a .env file in the root directory and add the required environment variables.

5. Start the backend server:

   npm run start

6. Start the frontend development server:

   cd frontend
   npm start

Project Structure

uber-clone/
├── Backend/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── app.js
│   └── server.js
├── frontend/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── redux/
│   │   ├── App.js
│   │   └── index.js
│   ├── public/
│   └── package.json
├── .env
├── package.json
└── readme.md

Backend package.json

{
  "name": "uber-clone-backend",
  "version": "1.0.0",
  "description": "Backend for Uber Clone project",
  "main": "server.js",
  "scripts": {
    "start": "node server.js",
    "dev": "nodemon server.js"
  },
  "dependencies": {
    "axios": "^0.21.1",
    "dotenv": "^8.2.0",
    "express": "^4.17.1",
    "mongoose": "^5.10.9"
  },
  "devDependencies": {
    "nodemon": "^2.0.4"
  }
}

Frontend package.json

{
  "name": "uber-clone-frontend",
  "version": "1.0.0",
  "private": true,
  "dependencies": {
    "axios": "^0.21.1",
    "react": "^17.0.1",
    "react-dom": "^17.0.1",
    "react-redux": "^7.2.2",
    "react-scripts": "4.0.0",
    "redux": "^4.0.5"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "eslintConfig": {
    "extends": ["react-app", "react-app/jest"]
  },
  "browserslist": {
    "production": [">0.2%", "not dead", "not op_mini all"],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  }
}

Conclusion

This project demonstrates a full-stack application with backend services for geocoding, distance calculation, and autocomplete suggestions, integrated with a frontend built using React and Redux. The project is designed to be easily understandable and extendable for further development.