https://github.com/apollo-level2-web-dev/nextmart-server
https://github.com/apollo-level2-web-dev/nextmart-server
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apollo-level2-web-dev/nextmart-server
- Owner: Apollo-Level2-Web-Dev
- Created: 2025-01-25T16:17:00.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-19T16:50:47.000Z (3 months ago)
- Last Synced: 2025-02-19T17:42:56.445Z (3 months ago)
- Language: TypeScript
- Size: 285 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NextMart - Server
NextMart is a robust and scalable backend solution for an e-commerce platform. It handles user authentication, product management, order processing, payment integration, and more. Built with Node.js, Express.js, and MongoDB, this project is designed for high performance and flexibility.
---
## Features
- **User Authentication**: Secure login, registration, and password reset using JWT.
- **Product Management**: CRUD operations for products.
- **Order Management**: Seamless order placement and processing.
- **Payment Integration**: Integrated with SSLCommerz for secure payment processing.
- **Cloudinary Integration**: Efficient image storage and retrieval.
- **Email Notifications**: Automated email services for various actions.
---
## Installation Guide
Follow the steps below to set up and run the project locally:
### Prerequisites
- Node.js (v20+)
- MongoDB (Local or Atlas)
- Yarn or npm
### Steps
1. Clone the repository:
```bash
git clone https://github.com/Apollo-Level2-Web-Dev/NextMert-Server.git
cd NextMert-Server
```
2. Install dependencies:
```bash
yarn install
# or
npm install
```
3. Create a `.env` file in the root directory and configure the environment variables as shown below.
4. Run the development server:
```bash
yarn dev
# or
npm run dev
```
5. Access the application on `http://localhost:3001`.
---
## Environment Variables
The following `.env` configuration is required to run the project:
```dotenv
# Environment
NODE_ENV=development
# Port
PORT=3001
# Database URL
DB_URL="mongodb+srv://:@cluster0.mongodb.net/?retryWrites=true&w=majority"
# Bcrypt Salt Rounds
BCRYPT_SALT_ROUNDS=12
# JWT Secrets and Expiry
JWT_ACCESS_SECRET=""
JWT_ACCESS_EXPIRES_IN=7d
JWT_REFRESH_SECRET=""
JWT_REFRESH_EXPIRES_IN=1y
JWT_OTP_SECRET=""
JWT_PASS_RESET_SECRET=""
JWT_PASS_RESET_EXPIRES_IN=15m
# Cloudinary Credentials
CLOUDINARY_CLOUD_NAME=""
CLOUDINARY_API_KEY=""
CLOUDINARY_API_SECRET=""
# Email Configuration
SENDER_EMAIL=""
SENDER_APP_PASS=""
# SSLCommerz Payment Info
STORE_NAME="teststore"
PAYMENT_API="https://sandbox.sslcommerz.com/gwprocess/v3/api.php"
VALIDATION_API="https://sandbox.sslcommerz.com/validator/api/validationserverAPI.php"
STORE_ID=""
STORE_PASSWORD=""
VALIDATION_URL=""
SUCCESS_URL=""
FAILED_URL=""
CANCEL_URL=""
```
---
## Scripts
- **Start Development Server**:
```bash
yarn dev
```
- **Build Production**:
```bash
yarn build
```
- **Run in Production Mode**:
```bash
yarn start
```
---
## API Documentation
[https://documenter.getpostman.com/view/28371413/2sAYQXpCyd](https://documenter.getpostman.com/view/28371413/2sAYQXpCyd)
**NextMart** is a single-vendor e-commerce platform. This repository contains the server-side implementation, providing robust backend services and APIs to power the platform.