https://github.com/murage-poc/node-store

A simple Node Js API e-commerce project using Express framework, JSON Web token, and Sequelize ORM
https://github.com/murage-poc/node-store

Last synced: 25 days ago
JSON representation

A simple Node Js API e-commerce project using Express framework, JSON Web token, and Sequelize ORM

• Host: GitHub
• URL: https://github.com/murage-poc/node-store
• Owner: murage-poc
• License: mit
• Created: 2020-03-06T09:25:56.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-15T08:31:51.000Z (almost 4 years ago)
• Last Synced: 2024-12-12T18:07:12.130Z (25 days ago)
• Language: TypeScript
• Homepage:
• Size: 129 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## NODE STORE API

A simple Node Js API e-commerce project using Express framework, JSON Web token, and Sequelize ORM

### Prerequisites

You will need the following things properly installed on your computer.

* [Git](https://git-scm.com/)

* [Node.js](https://nodejs.org/) (with npm)

### Quickstart

* Clone the project: `git clone https://github.com/mimidotsuser/node-store.git`

* Navigate into the `node-store` folder by running `cd node-store` on the terminal

* Run `npm install` to install the dependencies

* Rename [sample.env.json](sample.env.json) located in the project root  to ``.env.json``

* Replace the database credentials inside the ``.env.json``. Refer to [sequelize docs](https://sequelize.org/v5/manual/dialects.html) for more info.

* Run `` npm run start``. to start nodemon server on default port ``3000``

* Refer to the docs for the available API end points

### Linting

* `npm run lint`

### Building

* `npm run build` (outputs in the [dist](dist) folder)

#### N.B. 

1)  Tables will be created automatically by Sequelize ORM if the database connection is established

2)  Swagger API Docs and Insomina environment export can be found in the [docs](docs) folder

### License

[MIT License](LICENSE.md).