Shopzone

Rest API using Express, TypeScript and MongoDB

Installing

Clone the repository to your local machine

git clone https://github.com/gabriel-dsdc/shopzone.git

Navigate into root of repository

cd shopzone

Install dependencies

npm install

Create a .env file based on the .env.example file and populate following variables

PORT=3001
MONGODB_URI=<mongodb-connection-uri>
JWT_SECRET=<your-jwt-secret-key>

CLIENT_ID=<imgur-api-client-id>
CLIENT_SECRET=<imgur-api-client-secret>
REFRESH_TOKEN=<imgur-api-refresh-token>
ALBUM_HASH=<imgur-album-hash>
APP_URL=<app-url-for-stripe>
STRIPE_SECRET_KEY=<stripe-secret-key>
endpointSecret=<stripe-webhook-secret>

*Imgur is optional as it is only used to upload product images, but you can use external image URLs instead.
Stripe variables are only used in the payment route, you can use the application without them.*

Running the application

Development

npm run dev

Production

npm start

Rest API

Register a new user

Request

POST {{hostname}}/users/register

{
  "name": "",
  "email": "",
  "password": "",
  "confirmPassword": ""
}

Response

{
  "token": ""
}

Login

Request

POST {{hostname}}/users/login

{
  "email": "",
  "password": ""
}

Response

{
  "token": ""
}

Get user (yourself or admin)

Request

GET {{hostname}}/users/:id

Response

{
  "id": "",
  "name": "",
  "email": "",
  "role": ""
}

Update user

Request

PUT {{hostname}}/users/:id

{
  "name": "",
  "email": "",
  "password": "",
  "confirmPassword": ""
}

Response

{
  "name": "New name",
  "email": "new@email.com"
}

Delete user

Request

DELETE {{hostname}}/users/:id

Response

{
  "message": "User deleted successfully!"
}

Create product (admin or seller)

Request

POST {{hostname}}/products

{
  "name": "",
  "images": ["https://image.png"],
  "description": "",
  "price": 0,
  "quantity": 1,
  "category": "",
  "brand": "", // Optional
  "authors": "" // Optional
}

Response

{
  "name": "",
  "images": ["https://image.png"],
  "description": "",
  "price": 0,
  "quantity": 1,
  "category": "",
  "brand": "", // Optional
  "authors": "" // Optional
}

List products

Request

GET {{hostname}}/products

Response

[
  {
    "id": "",
    "name": "",
    "images": ["https://image.png"],
    "description": "",
    "price": 0,
    "quantity": 1,
    "category": "",
    "brand": "", // Optional
    "authors": "" // Optional
  }
]

Get product

Request

GET {{hostname}}/products/:id

Response

{
  "id": "",
  "name": "",
  "images": ["https://image.png"],
  "description": "",
  "price": 0,
  "quantity": 1,
  "category": "",
  "brand": "", // Optional
  "authors": "" // Optional
}

Update product

Request

PUT {{hostname}}/products/:id

{
  "name": "",
  "images": ["https://image.png"],
  "description": "",
  "price": 0,
  "quantity": 1,
  "category": "",
  "brand": "", // Optional
  "authors": "" // Optional
}

Delete product

Request

DELETE {{hostname}}/products/:id

Create user (admin)

Request

POST {{hostname}}/admin/createUser

{
  "name": "",
  "email": "",
  "password": "",
  "confirmPassword": "",
  "role": "client" // client or admin
}

List users (admin)

Request

GET {{hostname}}/admin/users

Response

[
  {
    {
      "name": "",
      "email": "",
      "password": "",
      "confirmPassword": "",
      "role": "client" // client or admin
    }
  }
]

Get configs

Request

GET {{hostname}}/admin/getConfigs

Response

{
  "allowNewUsers": true,
  "allowUserModifications": true
}

Update configs

Request

PUT {{hostname}}/updateConfigs

{
  "allowNewUsers": false,
  "allowUserModifications": false
}

Built With

• Expressjs - Web framework
• MongoDB - NoSQL Database
• Stripe - Payment API
• Imgur - Image API