https://github.com/kayprogrammer/ecommerce-store-express
An ecommerce API built in ExpressJS and MongoDB
https://github.com/kayprogrammer/ecommerce-store-express
Last synced: 2 months ago
JSON representation
An ecommerce API built in ExpressJS and MongoDB
- Host: GitHub
- URL: https://github.com/kayprogrammer/ecommerce-store-express
- Owner: kayprogrammer
- License: mit
- Created: 2024-07-27T01:59:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T20:48:59.000Z (over 1 year ago)
- Last Synced: 2025-01-25T21:25:38.672Z (over 1 year ago)
- Language: TypeScript
- Size: 3.45 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ECOMMERCE STORE EXPRESS
#### EXPRESS DOCS: [Documentation](https://expressjs.com/)
#### TYPESCRIPT DOCS: [Documentation](https://www.typescriptlang.org/docs/)
#### MONGOOSE DOCS: [Documentation](https://mongoosejs.com/docs/)
## Key Features
***Authentication and Authorization***: Secure your application with robust JWT-based authentication and authorization, ensuring that only authorized users can access protected resources. Features like Google auth and Facebook auth were included.
***Password Reset***: Provides a straightforward password reset process, allowing users to regain access to their accounts quickly and securely.
***Account Verification***: Ensures user authenticity through email verification, enhancing the security of user accounts and preventing fraudulent activities.
***Profiles Management***: Allows users to view, and update their profiles. Other features include shipping addresses view, create, update and delete.
***Shop Management***: Allows users and guests to navigate through products, add to wishlist, add to cart, create and confirm order, view orders etc.
***Seller Management***: Allows vendors/sellers to register as a seller, manage their products, variants and orders.
## How to run locally
* Download this repo or run:
```bash
$ git clone git@github.com:kayprogrammer/ecommerce-store-express.git
```
#### In the root directory:
- Install all dependencies
```bash
$ npm install
```
- Create an `.env` file and copy the contents from the `.env.example` to the file and set the respective values.
- Generate initial data
```bash
$ npm run seed
```
OR
```bash
$ make init
```
- Run Locally
```bash
$ npm run dev
```
OR
```bash
$ make run
```
- Run With Docker
```bash
$ docker-compose up --build -d --remove-orphans
```
OR
```bash
$ make build
```
- Test Coverage
```bash
$ npm run test
```
OR
```bash
$ make test
```
## Docs
#### API Url: [E-Store Swagger Docs](https://estore-express.fly.dev/)
