A simple Shop API

• Shop API
  • Table Of Contents
  • Tech Stack
  • Documentation
  • Demo
  • Getting Started
    • Prerequisites
    • Installation
    • Environment Variables
    • Run Locally
      • Development:
  • Contributing
    • Activate hooks
    • Add hook
  • Appendix - jsconfig.json
  • License
  • Authors

• Node.js - a JavaScript runtime environment for building and running server-side web applications
• Express.js - a web application framework for Node.js
• Mongodb - a NoSQL database
• OpenAPI 3.0 - an API description format for REST APIs

Documentation

Shop API hosted on Liara

You need to install:

• Node.js
• Mongodb

Upgrade npm to the latest version:

npm install npm@latest -g

Clone the repository and open project directory

git clone https://github.com/AriaRahmati/shop-api.git
cd shop-api

Install dependencies and run build command

npm install
npm run build

Create .env file

To run this project, you will need to add the following environment variables to your .env file.

PORT = 'SERVER_PORT' # Default: 3000

DATABASE_URI = 'YOUR_MONGODB_URI'

JWT_SECRET = 'YOUR_JWT_SECRET'

JWT_LIFETIME = 'PREFERRED_JWT_LIFETIME' # Example: '60', '120ms', '2 days', '10h', '7d'

npm start

npm run dev

Console output should look like this:

connecting to database...
connected to database successfully
server is listening on port {PORT}

Then you can see the docs at http://localhost:{PORT}/api/v1/docs

and start working with the api at http://localhost:{PORT}/api/v1

Based on commitlint documents:

npx husky install

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

See Conventional Commits for more info.

Shop API uses module-alias to make it easier to work with complex directory structures.

In order to make your intellisense to function, you need to add these paths to compilerOptions in jsconfig.json.

{
  "compilerOptions": {
    "baseUrl": "./",
    "module": "CommonJS",
    "target": "ESNext",
    "paths": {
      "@root/*": ["*"],
      "@src/*": ["src/*"],
      "@routes/*": ["src/routes/*"],
      "@configs/*": ["configs/*"],
      "@middlewares/*": ["src/http/middlewares/*"],
      "@controllers/*": ["src/http/controllers/*"],
      "@validators/*": ["src/http/validators/*"],
      "@models/*": ["src/models/*"],
      "@errors/*": ["src/errors/*"]
    }
  }
}

MIT

• @AriaRahmati