GoRent - Vehicle renting api

[hardikm9850]

Vehicle Renting App Backend Assignment

Project Overview

Build a RESTful API for a vehicle renting platform that includes user management (including admin), vehicle listings, booking, payment (simulated), and reviews.

Database

• Users: ID, Name, Email, Password, Phone, Address, License Number, Credit Card Information (encrypted), Role (admin, customer)
• Vehicles: ID, Type (car, bike, etc.), Model, Year, Price Per Day, Availability, Location, Image
• Bookings: ID, UserID, VehicleID, StartDate, EndDate, TotalPrice, Status (pending, confirmed, completed)
• Reviews: ID, UserID, VehicleID, Rating, Comment

API Endpoints

Public Endpoints

• User Management:
  • Signup
  • Login (with JWT generation)
  • Profile Update
  • Password Reset
• Vehicle Management:
  • Get Vehicles (with filtering options: type, location, price range, availability)
  • Get Vehicle Details
• Booking Management:
  • Create Booking
  • Get Bookings
  • Cancel Booking
• Payment: (Simulated)
  • Initiate Payment
  • Verify Payment
• Reviews:
  • Create Review
  • Get Reviews for a Vehicle
• Location-Based Services: (optional)
  • Get Vehicles Nearby

Admin Endpoints

• User Management:
  • Create User (for admin purposes)
  • Update User Role
  • Delete User
• Vehicle Management:
  • Create Vehicle
  • Update Vehicle
  • Delete Vehicle

Authentication and Authorization

• Implement JWT-based authentication for user login.
• Define roles (admin, customer) and assign permissions to each role.
• Use RBAC to protect API endpoints based on user roles.

Additional Features

• Vehicle Availability Calendar: Display vehicle availability for specific dates.
• Insurance Options: Offer different insurance packages.
• Push Notifications: Send notifications for booking confirmations, cancellations, etc.
• Geolocation: Use geolocation to find nearby vehicles.

Challenges and Learning Opportunities

• Database Design: Optimize database schema for efficient data retrieval and updates.
• Payment Integration: Simulate payment processing and handle refunds.
• Geolocation: Implement location-based services using a mapping API (e.g., Google Maps).
• Real-time Updates: Handle real-time updates for vehicle availability and booking status.
• Scalability: Design the system to handle increasing numbers of users and vehicles.
• Security: Protect sensitive admin data and prevent unauthorized access.

Mobile App Integration

• Design API responses suitable for mobile consumption (JSON format).
• Consider API rate limiting to prevent abuse.
• Optimize API performance for mobile devices.

Additional Tips

• Use a RESTful API framework like Gin or Echo to simplify development.
• Consider using a database ORM like GORM to interact with the database.
• Implement proper error handling and logging.
• Write clear and concise code with proper documentation.

[hardikm9850]

Repo link - WIP