URide Backend

URide is a backend service that provides APIs for user management and ride matching functionality. This Node.js application is built with Express.js and MongoDB.

Features

• User management system
• Ride matching functionality
• Geolocation-based services
• RESTful API architecture

Prerequisites

• Node.js (v14 or higher)
• MongoDB
• npm or yarn package manager

Installation

1. Clone the repository:

git clone <repository-url>
cd uridebackend

2. Install dependencies:

npm install

3. Create a .env file in the root directory with the following variables:

PORT=5000
MONGO_URI=your_mongodb_connection_string

Running the Application

Development Mode

npm run dev

Production Mode

npm start

The server will start running on the specified port (default: 5000).

API Endpoints

User Routes (/api/users)

• User registration and authentication
• User profile management
• User preferences

Match Routes (/api/match)

• Ride matching functionality
• Location-based matching
• Match preferences

Project Structure

uridebackend/
├── controllers/     # Business logic
├── models/         # Database models
├── routes/         # API routes
├── utils/          # Utility functions
├── index.js        # Application entry point
├── seed.js         # Database seeding script
└── package.json    # Project dependencies

Dependencies

• express: Web framework
• mongoose: MongoDB object modeling
• cors: Cross-origin resource sharing
• dotenv: Environment variable management
• geolib: Geolocation utilities

Development Dependencies

• nodemon: Development server with auto-reload

License

ISC

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request