Shopiley / shopaisley_backend

Backend of a functional e-commerce application.

Shopaisley Backend

An e-commerce platform.

Entity-Relationship Diagram

Run Locally

Clone the project

  git clone https://github.com/Shopaisley/shopaisley_backend.git

Go to the project directory

  cd shopaisley_backend

Install dependencies

  npm install

Start the server

  npm run start

Access the Application:

Open your web browser and navigate to http://localhost:3000/v1/docs or the URL specified in your application.

API Documention and UI

https://shopaisley-backend.onrender.com/v1/docs

API Documention and UI

https://shopaisley-backend.onrender.com/v1/docs

Contributing

After the initial set-up,

• Create a branch with your name or the feature you're working on git branch your-branch-name

• Switch to your branch git checkout your-branch-name

• Update your branch with the latest code by pulling changes from main git pull main

• Do your thing

• Commit to github

      - git add . or git add file-name
      - git commit -m "commit message"
      - git push origin your-branch-name
  

• Make a pull request on github

Technologies and Concepts Implemented

• Backend: NestJS ✅
• Database: Postgres ✅
• JWT Authentication ✅
• OpenAPI Practices ✅
• API Versioning ✅
• API Documentation (swagger) ✅