https://github.com/martinxcvi/node-ecommerce-api
Ecommerce API developed with Node.js, Express and MongoDB.
https://github.com/martinxcvi/node-ecommerce-api
api ecommerce express mongodb mongoose nodejs
Last synced: 2 months ago
JSON representation
Ecommerce API developed with Node.js, Express and MongoDB.
- Host: GitHub
- URL: https://github.com/martinxcvi/node-ecommerce-api
- Owner: MartinXCVI
- License: mit
- Created: 2025-01-12T22:49:24.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T00:53:47.000Z (2 months ago)
- Last Synced: 2025-03-07T01:34:54.418Z (2 months ago)
- Topics: api, ecommerce, express, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 651 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Node.js E-Commerce API
---
## 📄 Introduction
Node.js E-Commerce API, a backend service for an e-commerce application. It provides endpoints for managing users, products, categories, and orders. The API is built with Node.js + TypeScript, Express, and MongoDB.
Project still under development.
---
## 🛰️ Technologies Used
- **Node.js**: JavaScript runtime environment used to execute server-side code.
- **TypeScript**: Allows specifying the types of data being passed around within the code.
- **Express**: Fast and minimalist web framework for Node.js.
- **MongoDB**: Non-relational document database for agile development.
- **Mongoose**: ODM (Object Data Modeling) library for MongoDB and Node.js to manage data.
---
## 🗂️ Project Structure
```
node-ecommerce-api/
|── dist/...
|── node_modules/...
│── public/
│ ├── images/
│ ├── uploads/
│── src/
│ ├── config/
│ │ ├── dbConnection.js
│ │ ├── unProtectedPaths.js
| |
│ ├── controllers/
│ │ ├── categories.controller.js
│ │ ├── orders.controller.js
│ │ ├── products.controller.js
│ │ ├── users.controller.js
| |
│ ├── helpers/
│ │ ├── uploadImage.js
| |
| |── interfaces/
| | |── IEnvVariables.ts
| | |── IJwtPayload.ts
| | |── IMulterFilesRequest.ts
| | |── IMulterRequest.ts
| | |── IOrderItemRequest.ts
| |
| |── middlewares/
| | |── authJwt.ts
| |
│ ├── models/
| | |── interfaces/
| | | |── ICategory.ts
| | | |── IOrder.ts
| | | |── IOrderItem.ts
| | | |── IProduct.ts
| | | |── IUser.ts
| | |
│ │ ├── Category.model.js
│ │ ├── Order.model.js
│ │ ├── OrderItem.model.js
│ │ ├── Product.model.js
│ │ ├── User.model.js
| |
│ ├── routes/
│ │ ├── categories.routes.js
│ │ ├── orders.routes.js
│ │ ├── products.routes.js
│ │ ├── users.routes.js
| |
│ ├── utils/
│ │ ├── apiUrl.js
│ │ ├── validateEnvVariables.js
| |
│ ├── server.js
|
│── .env
│── .gitignore
│── LICENSE
│── package-lock.json
│── package.json
│── README.md
|── tsconfig.json
```
---
## 📋 Installation Guide
### Prerequisites
- Node.js (latest LTS version)
- MongoDB (local or cloud instance)
### Cloning the Repository
```sh
git clone https://github.com/MartinXCVI/node-ecommerce-api.git
cd node-ecommerce-api
```
### Install Dependencies
```sh
npm install
```
### Environment Variables (.env)
Create a `.env` file in the root directory and configure the following variables:
```
API_URL=/api/v1
DB_CONNECTION_STRING=mongodb+srv://:@.cekcm.mongodb.net/?retryWrites=true&w=majority&appName=
SALT_ROUNDS=
ACCESS_TOKEN_SECRET=
REFRESH_TOKEN_SECRET=
```
### Running the Project
- Start the server:
```sh
npm start
```
- Start the server in development mode (with nodemon):
```sh
npm run dev
```
---
## 📦 Dependencies
### Main Dependencies
- **`bcrypt`**: Library for hashing passwords.
- **`body-parser`**: Middleware to parse incoming request bodies.
- **`cookie-parser`**: Middleware to parse cookies.
- **`cors`**: Middleware to enable Cross-Origin Resource Sharing (CORS).
- **`dotenv`**: Loads environment variables from a `.env` file.
- **`express`**: Minimalistic web framework for Node.js.
- **`express-jwt`**: Middleware for handling JWT authentication.
- **`jsonwebtoken`**: Library for generating and verifying JWTs.
- **`mongoose`**: ODM for MongoDB to manage data.
- **`morgan`**: HTTP request logger middleware.
- **`multer`**: Middleware for handling file uploads.
### Development Dependencies
These are development dependencies required to build, run, and maintain the project efficiently.
### Type Definitions (`@types/*`)
TypeScript needs type definitions for JavaScript libraries to enable static type checking.
- **`@types/bcrypt`** - Type definitions for the `bcrypt` library (used for hashing passwords).
- **`@types/body-parser`** - Type definitions for `body-parser` (middleware for parsing request bodies).
- **`@types/cookie-parser`** - Type definitions for `cookie-parser` (middleware for handling cookies).
- **`@types/cors`** - Type definitions for `cors` (middleware to enable Cross-Origin Resource Sharing).
- **`@types/express`** - Type definitions for `express`, ensuring type safety in request handling.
- **`@types/jsonwebtoken`** - Type definitions for `jsonwebtoken` (used for JWT authentication).
- **`@types/morgan`** - Type definitions for `morgan` (HTTP request logger middleware).
- **`@types/multer`** - Type definitions for `multer` (middleware for handling file uploads).
- **`@types/node`** - Type definitions for Node.js, enabling TypeScript support for built-in modules.
### Development Tools
- **`nodemon`** - Automatically restarts the server during development when files change.
- **`ts-node`** - Allows running TypeScript files directly without needing a manual compilation step.
- **`typescript`** - The TypeScript compiler, required to transpile `.ts` files into JavaScript.
---
## 📚 Learn More
- [Node.js latest documentation](https://nodejs.org/docs/latest/api/)
- [TypeScript documentation](https://www.typescriptlang.org/docs/)
- [Nodemon project website](https://nodemon.io/)
- [Getting started with Express.js](https://expressjs.com/en/starter/installing.html)
- [Dotenv repository](https://github.com/motdotla/dotenv#readme)
- [MongoDB documentation](https://www.mongodb.com/docs/)
- [Mongoose documentation](https://mongoosejs.com/docs/)
- [bcrypt NPM package](https://www.npmjs.com/package/bcrypt)
- [Multer repository](https://github.com/expressjs/multer)
- [body-parser NPM package ](https://www.npmjs.com/package/body-parser)
- [cookie-parser NPM package](https://www.npmjs.com/package/cookie-parser)
- [Cross Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
- [express-jwt NPM package](https://www.npmjs.com/package/express-jwt)
- [JSON Web Tokens official website's introduction](https://jwt.io/introduction)
- [Morgan NPM package](https://www.npmjs.com/package/morgan)
---
## 📜 License
This project is licensed under the [MIT License](LICENSE).
---
## 🧑💻 Developer
- [**MartinXCVI**](https://github.com/MartinXCVI)