Features β’ Tech Stack β’ Installation β’ Documentation β’ Contributing
Car Drivers Platform is a comprehensive solution designed to streamline the process of finding, booking, and managing drivers. The application consists of three main components: a user-facing frontend, an administrative panel, and a robust backend API.
|
|
|
|
- Node.js v18+
- MongoDB 4.4+
- npm 8.x+
# Clone the repository
git clone https://github.com/Lagadnakul/Car-Drivers.git
cd Car-Drivers
# Install dependencies for all modules
npm run setup
# Start development servers
npm run dev
Manual Setup
cd backend
npm install
cp .env.example .env # Configure your environment variables
npm run dev
cd frontend
npm install
npm run dev
cd admin/Car-driver
npm install
npm run dev
Create a .env
file in the backend directory with the following variables:
PORT=5000
MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret_key
IMAGEKIT_PUBLIC_KEY=your_imagekit_public_key
IMAGEKIT_PRIVATE_KEY=your_imagekit_private_key
IMAGEKIT_URL_ENDPOINT=your_imagekit_url_endpoint
Car-Drivers/
βββ frontend/ # User-facing application
β βββ src/
β β βββ components/ # UI components
β β βββ pages/ # Application views
β β βββ hooks/ # Custom React hooks
β β βββ services/ # API services
βββ admin/ # Administration panel
β βββ Car-driver/
β βββ src/ # Admin application code
βββ backend/ # API server
βββ controllers/ # Route controllers
βββ models/ # Database models
βββ routes/ # API endpoints
βββ middleware/ # Express middleware
API documentation is available at /api/docs
after starting the backend server.
API Endpoints
Method | Endpoint | Description |
---|---|---|
POST | /api/auth/register |
Register a new user |
POST | /api/auth/login |
User login |
GET | /api/drivers |
List all drivers |
POST | /api/bookings |
Create new booking |
GET | /api/users/profile |
Get user profile |
- Payment gateway integration
- Real-time notifications
- Driver location tracking
- Mobile applications (iOS/Android)
- Advanced analytics dashboard
Contributions are welcome! Please check out our contribution guidelines.
- Fork the repository
- Create your feature branch:
git checkout -b feature/amazing-feature
- Commit your changes:
git commit -m 'Add some amazing feature'
- Push to the branch:
git push origin feature/amazing-feature
- Open a pull request
This project is licensed under the MIT License.
- Website: yourwebsite.com
- Email: email@example.com
- Twitter: @yourtwitter
Made with β€οΈ by Your Name