Golbahar Backend

This is the backend service for the Golbahar project, built using Node.js, Express, TypeScript, MongoDB, JWT for authentication, and Stripe for payment processing.

Table of Contents

• Requirements
• Installation
• Environment Variables
• Running the Backend Locally
• API Endpoints
• Contributing

Requirements

Make sure you have the following installed:

• Node.js (v14 or higher)
• MongoDB (you can use a local instance or MongoDB Atlas for a cloud database)
• Stripe Account (for payment processing)

Installation

1. Clone the repository:

   https://github.com/SardarAmiri/golbahar-server.git
   cd golbahar-server
   

2. Install the dependencies: npm install

3. Set up your MongoDB database: If using MongoDB locally, make sure it is running. If using MongoDB Atlas, create a cluster and obtain the connection string.

4. Set up Stripe: Create a Stripe account and get your API keys for payment processing.

Environment Variables

Create a .env file in the root directory of the backend project. Here are the required environment variables:

PORT = 5000;
MONGO_URI = your - mongodb - connection - string;
JWT_SECRET = your - secret - key;
STRIPE_SECRET_KEY = your - stripe - secret - key;
STRIPE_PUBLISHABLE_KEY = your - stripe - publishable - key;

Ensure to replace the placeholder values (your-mongodb-connection-string, etc.) with the actual values.

Running the Backend Locally

1. Run the backend development server:' nodemon server

   This will start the server at http://localhost:5000. The backend API will be served at this URL.

2. Testing API Endpoints:

You can test the API endpoints using tools like Postman or through the frontend once it is connected.

API Documentation

The following endpoints are available for user management, event management, bookings, and payment processing.

Users API

• POST /api/users/register - Register a new user
• POST /api/users/login - User login
• GET /api/users/current-user - Get the current authenticated user
• GET /api/users/get-all-users - Fetch all users
• PUT /api/users/update-users - Update user information

Events API

• POST /api/events/create-event - Create a new event
• PUT /api/events/update-event/:id - Update an existing event
• DELETE /api/events/delete-event/:id - Delete an event
• GET /api/events/get-events - Fetch all events
• GET /api/events/get-event/:id - Get a specific event by ID

Bookings API

• POST /api/bookings/create-booking - Create a new booking
• GET /api/bookings/get-user-bookings - Get all bookings for the authenticated user
• GET /api/bookings/get-all-bookings - Get all bookings (Admin)
• POST /api/bookings/cancel-bookings - Cancel a booking

Payments API

• POST /api/payments/create-payment-intent - Create a Stripe payment intent

Refer to the routes/ directory for more information on all available routes.

Contributing

We welcome contributions! Feel free to submit pull requests, open issues, or suggest improvements. Please follow our coding standards and test your changes before submitting.

Hosted Version

The live version of the project is available at: Hosted Golbahar Backend

[https://golbahar-server.onrender.com]