E-commerce Authentication & Order Management API

Overview

A robust backend API for an e-commerce platform built with Node.js, Express, and Mongoose, featuring user authentication (JWT), product catalog management, brand administration, order processing, and real-time order status updates via Socket.io.

Features

Node.js: Asynchronous event-driven JavaScript runtime for scalable network applications.
Express.js: Fast, unopinionated, minimalist web framework for Node.js.
Mongoose: MongoDB object modeling tool designed to work in an asynchronous environment.
MongoDB: NoSQL database for flexible and scalable data storage.
JWT (JSON Web Tokens): Secure stateless authentication for API endpoints.
Bcrypt: Hashing library for secure password storage.
Socket.io: Enables real-time, bidirectional, event-based communication for order status notifications.
Role-Based Authorization: Differentiates access for 'admin' and 'customer' roles.
Pagination: Efficiently retrieves product listings by brand.

Getting Started

Installation

Clone the repository:

git clone git@github.com:njaumatilda/task_7_e-commerce_auth_app.git
cd task_7_e-commerce_auth_app

Install project dependencies:
```
npm install
```
Create a .env file in the root directory and configure environment variables.
Start the development server:
```
npm start
```

Environment Variables

All required environment variables must be defined in a .env file in the project root.

PORT: The port number on which the Express server will run.
- Example: PORT=3000
DB_URL: The connection string for your MongoDB database.
- Example: DB_URL=mongodb://localhost:27017/ecommerce_db
JWT_KEY: A secret key used for signing and verifying JSON Web Tokens.
- Example: JWT_KEY=your_jwt_secret_key_here
SALT: The number of salt rounds to use when hashing passwords with bcrypt.
- Example: SALT=10

API Documentation

Base URL

http://localhost:[PORT] (Replace [PORT] with the value from your .env file)

All authenticated endpoints require a Bearer token in the Authorization header. Example: Authorization: Bearer <your_jwt_token>

Endpoints

POST /auth/register

Registers a new user with an email, password, full name, and role. Request:

{
  "fullName": "Jane Doe",
  "email": "jane.doe@example.com",
  "password": "SecurePassword123",
  "role": "customer"
}

Response:

{
  "message": "Account created successfully",
  "newUser": {
    "fullName": "Jane Doe",
    "email": "jane.doe@example.com",
    "role": "customer",
    "_id": "65f8c8d8b2a3c4d5e6f7a8b9",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

409 Conflict: Email is already in use.
500 Internal Server Error: Server-side error.

POST /auth/login

Authenticates a user and returns a JWT token. Request:

{
  "email": "jane.doe@example.com",
  "password": "SecurePassword123"
}

Response:

{
  "message": "Login was successful",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "userId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "fullName": "Jane Doe",
    "email": "jane.doe@example.com",
    "role": "customer"
  }
}

Errors:

404 Not Found: User does not exist.
401 Unauthorized: Incorrect password.
500 Internal Server Error: Server-side error.

GET /products

Retrieves a list of all products. Request: None Response:

[
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c0",
    "productName": "Wireless Earbuds",
    "brand": "65f8c8d8b2a3c4d5e6f7a8c1",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "category": "Electronics",
    "cost": 59.99,
    "productImages": ["url1.jpg", "url2.jpg"],
    "description": "High-quality wireless earbuds...",
    "stockStatus": "in-stock",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
]

Errors:

500 Internal Server Error: Server-side error.

GET /products/:brand/:page/:limit

Retrieves paginated products for a specific brand. Request:

brand (Path Parameter): The ID of the brand.
page (Path Parameter): The page number for pagination.
limit (Path Parameter): The number of items per page. Response:

{
  "message": "Product(s) retrieved successfully",
  "brandProducts": {
    "docs": [
      {
        "_id": "65f8c8d8b2a3c4d5e6f7a8c0",
        "productName": "Wireless Earbuds",
        "brand": {
          "_id": "65f8c8d8b2a3c4d5e6f7a8c1",
          "brandName": "SoundWave",
          "aboutBrand": "Innovating audio solutions",
          "country": "USA",
          "socialLinks": [],
          "website": "http://soundwave.com"
        },
        "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
        "category": "Electronics",
        "cost": 59.99,
        "productImages": ["url1.jpg", "url2.jpg"],
        "description": "High-quality wireless earbuds...",
        "stockStatus": "in-stock",
        "createdAt": "2023-01-01T12:00:00.000Z",
        "updatedAt": "2023-01-01T12:00:00.000Z",
        "__v": 0
      }
    ],
    "totalDocs": 1,
    "limit": 2,
    "page": 1,
    "totalPages": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": false,
    "prevPage": null,
    "nextPage": null
  }
}

Errors:

400 Bad Request: Invalid ID format for brand.
500 Internal Server Error: Server-side error.

POST /products

Adds a new product. Requires admin role. If the brand does not exist, it will be created. Request:

{
  "productName": "Smart Watch Pro",
  "brandName": "TechGadgets",
  "aboutBrand": "Leading innovation in wearable tech.",
  "country": "Canada",
  "socialLinks": ["http://facebook.com/techgadgets"],
  "website": "http://techgadgets.com",
  "category": "Wearables",
  "cost": 199.99,
  "productImages": ["watch1.jpg", "watch2.jpg"],
  "description": "Advanced smartwatch with health tracking.",
  "stockStatus": "in-stock"
}

Response:

{
  "message": "Product added successfully",
  "newProduct": {
    "productName": "Smart Watch Pro",
    "brand": "65f8c8d8b2a3c4d5e6f7a8c2",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "category": "Wearables",
    "cost": 199.99,
    "productImages": ["watch1.jpg", "watch2.jpg"],
    "description": "Advanced smartwatch with health tracking.",
    "stockStatus": "in-stock",
    "_id": "65f8c8d8b2a3c4d5e6f7a8c3",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

401 Unauthorized: User does not have permissions to add products.
500 Internal Server Error: Server-side error.

DELETE /products/:id

Deletes a product by ID. Requires admin role. Request:

id (Path Parameter): The ID of the product to delete. Response:

{
  "message": "Product deleted successfully",
  "deletedProduct": {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c3",
    "productName": "Smart Watch Pro",
    "brand": "65f8c8d8b2a3c4d5e6f7a8c2",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "category": "Wearables",
    "cost": 199.99,
    "productImages": ["watch1.jpg", "watch2.jpg"],
    "description": "Advanced smartwatch with health tracking.",
    "stockStatus": "in-stock",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

400 Bad Request: Invalid ID format.
401 Unauthorized: User does not have permissions to delete products.
404 Not Found: Product does not exist.
500 Internal Server Error: Server-side error.

GET /brands

Retrieves a list of all brands. Request: None Response:

[
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c1",
    "brandName": "SoundWave",
    "aboutBrand": "Innovating audio solutions.",
    "country": "USA",
    "socialLinks": [],
    "website": "http://soundwave.com",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
]

Errors:

500 Internal Server Error: Server-side error.

POST /brands

Adds a new brand. Requires admin role. Request:

{
  "brandName": "GlobalFootwear",
  "aboutBrand": "Specializing in athletic and casual shoes.",
  "country": "Germany",
  "socialLinks": ["http://instagram.com/globalfootwear"],
  "website": "http://globalfootwear.de"
}

Response:

{
  "message": "Brand added successfully",
  "newBrand": {
    "brandName": "GlobalFootwear",
    "aboutBrand": "Specializing in athletic and casual shoes.",
    "country": "Germany",
    "socialLinks": ["http://instagram.com/globalfootwear"],
    "website": "http://globalfootwear.de",
    "_id": "65f8c8d8b2a3c4d5e6f7a8c4",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

401 Unauthorized: User does not have permissions to add brands.
409 Conflict: Brand already exists.
500 Internal Server Error: Server-side error.

PUT /brands

Updates an existing brand's details. Requires admin role. Request:

{
  "brandName": "GlobalFootwear",
  "country": "USA",
  "website": "http://globalfootwear.com"
}

Response:

{
  "message": "Brand updated successfully",
  "findBrandToUpdate": {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c4",
    "brandName": "GlobalFootwear",
    "aboutBrand": "Specializing in athletic and casual shoes.",
    "country": "USA",
    "socialLinks": ["http://instagram.com/globalfootwear"],
    "website": "http://globalfootwear.com",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

401 Unauthorized: User does not have permissions to update brands.
404 Not Found: Brand does not exist.
500 Internal Server Error: Server-side error.

DELETE /brands

Deletes a brand by name. Requires admin role. Request:

brandName (Query Parameter): The name of the brand to delete. Response:

{
  "message": "Brand deleted successfully",
  "findBrandToDelete": {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c4",
    "brandName": "GlobalFootwear",
    "aboutBrand": "Specializing in athletic and casual shoes.",
    "country": "USA",
    "socialLinks": ["http://instagram.com/globalfootwear"],
    "website": "http://globalfootwear.com",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

401 Unauthorized: User does not have permissions to delete brands.
404 Not Found: Brand does not exist.
500 Internal Server Error: Server-side error.

GET /order

Retrieves all orders. Requires admin role. Request: None Response:

[
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c5",
    "productName": "Wireless Earbuds",
    "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "quantity": 1,
    "totalCost": 59.99,
    "shippingStatus": "pending",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
]

Errors:

401 Unauthorized: User does not have permissions to view orders.
500 Internal Server Error: Server-side error.

GET /order/:id

Retrieves a single order by ID. Requires admin role. Request:

id (Path Parameter): The ID of the order. Response:

{
  "_id": "65f8c8d8b2a3c4d5e6f7a8c5",
  "productName": "Wireless Earbuds",
  "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
  "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
  "quantity": 1,
  "totalCost": 59.99,
  "shippingStatus": "pending",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z",
  "__v": 0
}

Errors:

400 Bad Request: Invalid ID format.
401 Unauthorized: User does not have permissions to view orders.
404 Not Found: Order does not exist.
500 Internal Server Error: Server-side error.

POST /order

Creates a new order. Requires customer role. Request:

{
  "productName": "Wireless Earbuds",
  "quantity": 2,
  "shippingStatus": "pending"
}

Response:

{
  "message": "Order created successfully",
  "newOrder": [
    {
      "productName": "Wireless Earbuds",
      "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
      "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
      "quantity": 2,
      "totalCost": 119.98,
      "shippingStatus": "pending",
      "_id": "65f8c8d8b2a3c4d5e6f7a8c6",
      "createdAt": "2023-01-01T12:00:00.000Z",
      "updatedAt": "2023-01-01T12:00:00.000Z",
      "__v": 0
    }
  ]
}

Errors:

401 Unauthorized: User does not have permissions to create orders.
404 Not Found: Product does not exist.
500 Internal Server Error: Server-side error.

PATCH /order/:id

Updates the shipping status of an order. Requires admin role. Notifies the order owner via Socket.io. Request:

id (Path Parameter): The ID of the order to update.

{
  "shippingStatus": "shipped"
}

Response:

{
  "message": "Order status updated successfully",
  "updatedOrder": {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c6",
    "productName": "Wireless Earbuds",
    "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "quantity": 2,
    "totalCost": 119.98,
    "shippingStatus": "shipped",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
}

Errors:

400 Bad Request: Invalid ID format or Invalid order status value.
401 Unauthorized: User does not have permissions to change order status.
404 Not Found: Order does not exist.
500 Internal Server Error: Server-side error.

GET /profile

Retrieves the profile of the authenticated user. Request: None Response:

{
  "_id": "65f8c8d8b2a3c4d5e6f7a8b9",
  "fullName": "Jane Doe",
  "email": "jane.doe@example.com",
  "role": "customer"
}

Errors:

404 Not Found: User not found.
500 Internal Server Error: Server-side error.

GET /order-history

Retrieves order history. If admin, retrieves all orders. If customer, retrieves personal orders. Request: None Response (Customer Role Example):

[
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c5",
    "productName": "Wireless Earbuds",
    "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "quantity": 1,
    "totalCost": 59.99,
    "shippingStatus": "pending",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  }
]

Response (Admin Role Example - similar to GET /order):

[
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c5",
    "productName": "Wireless Earbuds",
    "productId": "65f8c8d8b2a3c4d5e6f7a8c0",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8b9",
    "quantity": 1,
    "totalCost": 59.99,
    "shippingStatus": "pending",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "updatedAt": "2023-01-01T12:00:00.000Z",
    "__v": 0
  },
  {
    "_id": "65f8c8d8b2a3c4d5e6f7a8c6",
    "productName": "Smart Watch Pro",
    "productId": "65f8c8d8b2a3c4d5e6f7a8c3",
    "ownerId": "65f8c8d8b2a3c4d5e6f7a8d0",
    "quantity": 1,
    "totalCost": 199.99,
    "shippingStatus": "delivered",
    "createdAt": "2023-01-02T12:00:00.000Z",
    "updatedAt": "2023-01-02T12:00:00.000Z",
    "__v": 0
  }
]

Errors:

404 Not Found: User not found.
500 Internal Server Error: Server-side error.

Technologies Used

Category	Technology	Version	Purpose
Backend	Node.js	^18.x.x	JavaScript runtime environment
	Express	^5.1.0	Web framework for API development
Database	MongoDB	N/A	NoSQL database
	Mongoose	^8.16.4	ODM for MongoDB
	mongoose-paginate-v2	^1.9.1	Pagination plugin for Mongoose
Authentication	jsonwebtoken	^9.0.2	JWT implementation for API security
	bcrypt	^6.0.0	Password hashing library
Real-time	Socket.io	^4.8.1	Real-time communication for notifications
Utilities	dotenv	^17.2.0	Loads environment variables from a .env file

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, please follow these steps:

Fork the repository.
Create a new branch for your feature or bugfix: git checkout -b feature/your-feature-name or bugfix/issue-description.
Make your changes and ensure tests (if applicable) pass.
Commit your changes with a clear and descriptive message: git commit -m "feat: Add new user registration endpoint".
Push your branch to your forked repository: git push origin feature/your-feature-name.
Open a Pull Request to the main branch of the original repository.

Author Info

Matilda Njau
- GitHub: https://github.com/njaumatilda

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
contollers		contollers
middlewares		middlewares
models		models
routes		routes
.gitignore		.gitignore
README.md		README.md
app.js		app.js
db.js		db.js
package-lock.json		package-lock.json
package.json		package.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

E-commerce Authentication & Order Management API

Overview

Features

Getting Started

Installation

Environment Variables

API Documentation

Base URL

Endpoints

POST /auth/register

POST /auth/login

GET /products

GET /products/:brand/:page/:limit

POST /products

DELETE /products/:id

GET /brands

POST /brands

PUT /brands

DELETE /brands

GET /order

GET /order/:id

POST /order

PATCH /order/:id

GET /profile

GET /order-history

Technologies Used

Contributing

Author Info

Badges

About

Uh oh!

Releases

Packages

Languages

njaumatilda/E-Commerce-API

Folders and files

Latest commit

History

Repository files navigation

E-commerce Authentication & Order Management API

Overview

Features

Getting Started

Installation

Environment Variables

API Documentation

Base URL

Endpoints

POST /auth/register

POST /auth/login

GET /products

GET /products/:brand/:page/:limit

POST /products

DELETE /products/:id

GET /brands

POST /brands

PUT /brands

DELETE /brands

GET /order

GET /order/:id

POST /order

PATCH /order/:id

GET /profile

GET /order-history

Technologies Used

Contributing

Author Info

Badges

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages