https://github.com/symonmuchemi/shopsmart
A robust RESTful API for e-commerce operations built with Node.js and MongoDB. Features comprehensive endpoints for product management, secure user authentication, shopping cart operations, and payment integration (MPesa). Designed to support scalable e-commerce applications with detailed documentation for front-end integration.
https://github.com/symonmuchemi/shopsmart
daraja-api mongoose mpesa-payments nodejs typescript
Last synced: about 2 months ago
JSON representation
A robust RESTful API for e-commerce operations built with Node.js and MongoDB. Features comprehensive endpoints for product management, secure user authentication, shopping cart operations, and payment integration (MPesa). Designed to support scalable e-commerce applications with detailed documentation for front-end integration.
- Host: GitHub
- URL: https://github.com/symonmuchemi/shopsmart
- Owner: SymonMuchemi
- Created: 2024-12-20T08:12:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T15:13:00.000Z (about 1 year ago)
- Last Synced: 2025-10-20T10:01:55.241Z (8 months ago)
- Topics: daraja-api, mongoose, mpesa-payments, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 1.42 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShopSmart
## Description
A robust RESTful API for e-commerce operations built with Node.js and MongoDB.
## Features
- [x] User Authentication
- [x] Product Management
- [x] image storage
- [x] Shopping Cart Operations
- [x] Purchase Management
- [x] Stripe Payment Integration
## Technologies
- [Node.JS](www.nodejs.org): JavaScript runtime.
- [Express](https://expressjs.com/): Web framework for Node.js.
- [Amazon S3](https://aws.amazon.com/s3/): Cloud storage.
- [Multer](https://www.npmjs.com/package/multer): Middleware for handling multipart/form-data.
- [AWS EC2](https://aws.amazon.com/ec2/): for deployment.
- [MongoDB](https://www.mongodb.com/): NoSQL database.
- [Mongoose](https://mongoosejs.com/): Object Relational Mapper for MongoDB.
- [JWT](https://jwt.io/): Secure user authentication.
- [Stripe](https://stripe.com/docs): Payment processing platform.
## Database Design
## Installation
1. Clone the repository from a terminal or command prompt.
```bash
git clone https://www.github.com/symonmuchemi/ShopSmart.git
```
2. Navigate to the project directory.
```bash
cd ShopSmart
```
3. Install the project dependencies.
```bash
npm install
```
4. Create a `.env` file in the root directory and add the following environment variables.
```env
PORT=3000
MONGO_DB_URL=mongodb://localhost:3000/shopsmart
JWT_SECRET=your_secret_key
JWT_EXPIRATION=1d
STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key
STRIPE_SECRET_KEY=your_stripe_secret_key
S3_BUCKET_REGION='your_s3_bucket_region'
S3_BUCKET_NAME='your_s3_bucket_name'
S3_ACCESS_KEY='your_s3_access_key_id'
S3_SECRET_ACCESS_KEY='your s3_secret_access_key'
```
5. Start the application.
```bash
npm run dev
```
6. Access the application on `http://localhost:3000`.
## Author
[Symon Muchemi](https://www.github.com/symonmuchemi)