RELIST Backend

A powerful Node.js application designed to deliver seamless functionality with a reliable backend architecture. The project includes robust features for managing data and APIs, ensuring optimal performance and scalability. Checkout a demo frontend: live frontend website

Features

• 🌟 Comprehensive API Endpoints: Provides RESTful endpoints for efficient data handling.
• 📦 Dynamic Product Management: Add, update, and delete products seamlessly.
• 🔍 Stock Management: Real-time product availability updates based on stock levels.
• 📧 Order Processing: Handles customer orders with validation and stock updates.
• 📊 Scalable Architecture: Built for extensibility with modular design.
• 🔐 Secure Configuration: Environment variables ensure sensitive data protection.
• 📂 Built-in Timestamps: Automatically track data creation and updates.
• 🚀 Ready for Deployment: Preconfigured for Vercel or other deployment platforms.

Tech Stack

• Backend: Node.js, Express.js
• Database: MongoDB
• Configuration Management: Dotenv
• Build Tool: TypeScript

Getting Started

Follow the steps below to set up the project locally on your machine.

Prerequisites

Ensure the following are installed on your system:

• Node.js (version 16 or above)
  Download Node.js
• MongoDB (local instance or cloud-based like MongoDB Atlas)
  MongoDB Installation Guide
• Package Manager: NPM (comes with Node.js) or Yarn

Installation

1. Clone the repository:

   git clone https://github.com/joychandrauday/relist-backend.git

2. Navigate to the project directory

   cd student-stationary-backend

3. Install dependencies:

   npm install

   or

   yarn install

4. Environment Variables:

   Create a .env file in the root directory and provide the necessary variables:

       PORT=3000
       DB_URL= mongodb+srv://<username>:<password>@cluster.mongodb.net/your-database

5. Run the Application: Start the server in development mode:

       npm run start:dev

📌 API Endpoints

🏷️ Listing Management (Products)

• GET /api/v1/listings - Retrieve all listings.
• GET /api/v1/listings/:listingId - Retrieve a single listing.
• POST /api/v1/listings - Add a new listing.
• PUT /api/v1/listings/:listingId - Update an existing listing.
• DELETE /api/v1/listings/:listingId - Delete a listing.

🏷️ Auth Management

• POST /api/v1/register - Register a new user
• POST /api/v1/login - log in a new user

📦 Order Management (Track Purchases & Sales)

• POST /api/v1/orders - Create a new order.
• GET /api/v1/orders - Fetch all orders (Admin).
• GET /api/v1/orders/user/:userId - Retrieve orders of a specific user.
• GET /api/v1/orders/:orderId - Retrieve order details by Order ID.
• PATCH /api/v1/orders/:orderId - Update an order status.
• DELETE /api/v1/orders/:orderId - Delete an order by ID.
• GET /api/v1/orders/verify/payment - Verify payment.

💰 Transaction Management

• POST /api/v1/transactions - Create a new transaction.
• GET /api/v1/transactions - Fetch all transactions (Admin).
• GET /api/v1/transactions/user/:userId - Retrieve transaction history for a user.
• GET /api/v1/transactions/:transactionId - Retrieve details of a specific transaction.
• PATCH /api/v1/transactions/:transactionId - Update transaction status.
• DELETE /api/v1/transactions/:transactionId - Delete a transaction.

👤 User Management

• GET /api/v1/users - Fetch all users (Admin).
• GET /api/v1/users/:userId - Retrieve a user by ID.
• PUT /api/v1/users/:userId - Update user profile.
• DELETE /api/v1/users/:userId - Delete a user (Admin).

💬 Messages (Optional)

• GET /api/v1/messages/:userId - Fetch user messages.
• POST /api/v1/messages - Send a message.
• DELETE /api/v1/messages/:messageId - Delete a message.

🔧 Admin Management (Optional)

• GET /api/v1/admin/dashboard - Admin panel overview.
• GET /api/v1/admin/users - Fetch all users (Admin).
• PATCH /api/v1/admin/users/:userId/unban - Unban a user.
• GET /api/v1/admin/listings - Fetch all listings (Admin).

Project Structure

📦project-root
┣ 📂dist # Compiled output (after build)
┣ 📂src # Source code
┃ ┣📂app ┃ ┃ ┣ 📂models # Mongoose models
┃ ┃ ┣ 📂routes # Route handlers
┃ ┃ ┣ 📂services # Business logic
┃ ┗ app.js
┃ ┗ server.js # Main server file
┣ 📜package.json # Project dependencies and scripts
┣ 📜README.md # Project documentation
┗ .env # Environment variables

Contributing

We welcome contributions to enhance this project!

1. Fork the repository
2. Create a branch for your feature:

   git checkout -b feature-name

3. Commit your changes

   git commit -m 'Add new feature'

4. Push your feature

   git push origin feature-name

Contact

For questions or feedback, contact:

• Name: Joy Chandra Uday
• Email: joychandrauda@gmail.com
• Website: https://joychandrauday.web.app/