NIMI e-Commerce Web Application

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About The Project

This is MERN Stack simple e-commerce web application. There is two roles as Customer and Admin.

* Customer can view the all products and search products.
* Before buy or add to the cart customer must login or register to the system.
* After the add to the cart customer can place an order.

* Admin must login to the system (if you want to be an Admin you should register as a customer and go to your mongodb database --> user collection --> edite the role attribute as 1 [role:'1']).
* Admin can create update delete categories.
* Admin can create update delete products.
* Admin can conform the customer's orders.

(back to top)

Built With

• MongoDB - MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.

• Express.js - Express.js, or simply Express, is a back end web application framework for Node.js, released as free and open-source software under the MIT License. It is designed for building web applications and APIs. It has been called the de facto standard server framework for Node.js.

• React.js - React is a free and open-source front-end JavaScript library for building user interfaces based on UI components.

• Node.js - Node.js is an open-source, cross-platform, back-end JavaScript runtime environment that runs on the V8 engine and executes JavaScript code outside a web browser.
  
  Other used Packages
  
  server side:
  

  • bcrypt
    
  • cloudinary
    
  • concurrently
    
  • cookie-parser
    
  • jsonwebtoken
    
  • express-fileupload
    
  • cors
    
    

  client side:
  

  • react-toastify
    
  • axios
    
  • react-router-dom
    
    

(back to top)

Getting Started

Prerequisites

1. Must have an Installed Node.js to your local machine
2. Must have a MongoDB Account
3. Must have a Cloudanary Account

Installation

1. Clone the repo

   git clone https://github.com/amila1998/nimi-e-commerce-web-app.git

2. Install NPM packages

     npm run install-all

3. Create .env file inside the server folder and Enter Following Keys

      MONGODB_URL = (your mongoDB Url)
   
      ACCESS_TOKEN_SECRET = adasdhasdhauiqwbqw0+ajdakjdhasd
      REFRESH_TOKEN_SECRET = ajdasdadwuiqwjhasvdasdajdahdka
   
      CLOUD_NAME=(Your Cloudanary Name)
      CLOUD_API_KEY=(Your Cloudanary Api Key)
      CLOUD_API_SECRET=(Your Cloudanary SECRET Key)

4. To Run the Application

     npm run dev

   or to run the Server only

    npm run server

   and to run the client

    npm run client

   Server Running on http://localhost:5000
   Default Client Runnig on http://localhost:3000

(back to top)

Usage

Customer

Admin

(back to top)

Roadmap

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

(back to top)

Contact

Your Name - @real_amiladevin - amiladevin@gmail.com

Project Link: (https://github.com/amila1998/nimi-e-commerce-web-app

(back to top)