mosh1331 / e-commerce-api

An e-commerce web API. Features full CRUD on products, carts order and users

E commerce web api

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• Contact
• Acknowledgements

About The Project

This is an ecommerce API built with NodeJs. It features authentication, full CRUD ability on products, order, cart and user. Documentation here: https://documenter.getpostman.com/view/11784799/UVJhDEyt

Environmental variables

JWT_SECRET
PORT=3000
MONGODB_URL
FLUTTERWAVE_V3_SECRET_KEY
FLUTTERWAVE_v3_PUBLIC_KEY

Built With

• NodeJs
  • Mongoose
  • Express
• MongoDB
  • Database management
• Jest
  • Node testing with jest

Getting Started

1 fork the repo

2. clone to your local machine

3. npm install

4. npm start

Prerequisites

• npm packages

npm install

Installation

1. fork the repo

2. clone the Repo

3. install dependencies npm install

4. run dev server npm run dev

5. Test components npm test

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Twitter - @breellz

Facebook

stackoverflow

LinkedIn

Instagram

Project Link: https://github.com/breellz/e-commerce-api

Acknowledgements

• Stackoverflow