https://github.com/brockaltug/orm-ecom-backend
E-Commerce Backend 🛒 solution for managing an e-commerce platform. This API supports categories, products, tags, and their relationships, built using Node.js, Express.js, Sequelize, and PostgreSQL. The project demonstrates a scalable relational database architecture with RESTful API endpoints for CRUD operations.
https://github.com/brockaltug/orm-ecom-backend
dotenv expressjs insomnia nodejs object-relational-mapping postgresql sequelize
Last synced: 3 months ago
JSON representation
E-Commerce Backend 🛒 solution for managing an e-commerce platform. This API supports categories, products, tags, and their relationships, built using Node.js, Express.js, Sequelize, and PostgreSQL. The project demonstrates a scalable relational database architecture with RESTful API endpoints for CRUD operations.
- Host: GitHub
- URL: https://github.com/brockaltug/orm-ecom-backend
- Owner: BrockAltug
- Created: 2024-11-13T06:35:31.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-03T10:24:21.000Z (6 months ago)
- Last Synced: 2025-02-05T21:01:06.636Z (5 months ago)
- Topics: dotenv, expressjs, insomnia, nodejs, object-relational-mapping, postgresql, sequelize
- Language: JavaScript
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# E-Commerce Backend
## Description
The E-Commerce Backend is a comprehensive backend solution for managing an e-commerce platform. This API provides functionality to manage categories, products, tags, and their relationships. Built using Node.js, Express.js, Sequelize, and PostgreSQL, this project demonstrates a scalable, relational database architecture while offering robust RESTful API endpoints.
[View Demo Video](https://drive.google.com/file/d/1xPIg20mIDbsKOS97dCxLzpXYmqCIG0I2/view?usp=sharing)
---
## Table of Contents
- [Description](#description)
- [How to Use](#how-to-use)
- [Example API Usage](#example-api-usage)
- [Technologies Used](#technologies-used)
- [Summary](#summary)
---
## How to Use
1. **Install Dependencies:**
Navigate to the project directory and install the necessary dependencies:
```bash
npm install
```
2. **Configure Environment Variables:**
Create a `.env` file in the root directory and add your PostgreSQL credentials:
```env
DB_NAME=ecommerce_db
DB_USER=your_username
DB_PASSWORD=your_password
```
3. **Create and Seed the Database:**
Run the schema file to create the database and tables:
```bash
psql -U your_username -d ecommerce_db -f db/schema.sql
```
Seed the database with sample data:
```bash
npm run seed
```
4. **Start the Server:**
Start the API server:
```bash
npm start
```
5. **API Testing:**
Use a tool like **Insomnia** or **Postman** to test the API endpoints.
---
## Example API Usage
### **Category Routes**
- **GET /api/categories** - Retrieve all categories.
- **GET /api/categories/:id** - Retrieve a single category by ID.
- **POST /api/categories** - Create a new category.
```json
{
"category_name": "New Category"
}
```
- **PUT /api/categories/:id** - Update a category by ID.
```json
{
"category_name": "Updated Category"
}
```
- **DELETE /api/categories/:id** - Delete a category by ID.
### **Product Routes**
- **GET /api/products** - Retrieve all products.
- **GET /api/products/:id** - Retrieve a single product by ID.
- **POST /api/products** - Create a new product.
```json
{
"product_name": "New Product",
"price": 29.99,
"stock": 15,
"category_id": 1
}
```
- **PUT /api/products/:id** - Update a product by ID.
```json
{
"product_name": "Updated Product",
"price": 19.99,
"stock": 10
}
```
- **DELETE /api/products/:id** - Delete a product by ID.
### **Tag Routes**
- **GET /api/tags** - Retrieve all tags.
- **GET /api/tags/:id** - Retrieve a single tag by ID.
- **POST /api/tags** - Create a new tag.
```json
{
"tag_name": "New Tag"
}
```
- **PUT /api/tags/:id** - Update a tag by ID.
```json
{
"tag_name": "Updated Tag"
}
```
- **DELETE /api/tags/:id** - Delete a tag by ID.
---
## Technologies Used
- **Node.js**: Runtime environment for building the server.
- **Express.js**: Framework for routing and middleware.
- **Sequelize**: ORM for PostgreSQL to manage relational database operations.
- **PostgreSQL**: Relational database for structured data storage.
- **dotenv**: For environment variable management.
- **Insomnia**: API testing and debugging tool.
---
## Summary
The E-Commerce Backend provides a robust and flexible solution for managing an online store's backend operations. With support for categories, products, tags, and their relationships, it serves as an efficient and scalable foundation for any e-commerce platform.