https://github.com/wisnuuakbr/simple-ecommerce

Simple e-commerce using Express JS, MySQL, Sequelize ORM, Clean Arch, Docker
https://github.com/wisnuuakbr/simple-ecommerce

clean-architecture docker expressjs mysql nodejs orm sequelize

Last synced: 1 day ago
JSON representation

Simple e-commerce using Express JS, MySQL, Sequelize ORM, Clean Arch, Docker

• Host: GitHub
• URL: https://github.com/wisnuuakbr/simple-ecommerce
• Owner: wisnuuakbr
• Created: 2024-10-24T13:40:26.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T02:56:44.000Z (2 months ago)
• Last Synced: 2024-11-11T06:34:06.320Z (2 months ago)
• Topics: clean-architecture, docker, expressjs, mysql, nodejs, orm, sequelize
• Language: JavaScript
• Homepage:
• Size: 92.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple e-commerce

A simple e-commerce backend service using :

  


_*nb:_ **_The structure and clean architecture in this project aren't perfect yet, but this is merely an approach to implementing Uncle Bob's clean architecture concept.  It will be updated if there are any changes in the future._**

## Requirements

this e-commerce is currently extended with the following requirements.  

Instructions on how to use them in your own application are linked below.

| Requirement | Version |

| ----------- | ------- |

| Node JS     | 20.10.0 |

| Express JS  | 4.16.1  |

| MySQL       | 8.0.30  |

## Entity Relationship Diagram

![Entity Relation Diagram](docs/ERD.png)

## Installation

Make sure the requirements above already install on your system.  

Clone the project to your directory and install the dependencies.

```bash

$ git clone https://github.com/wisnuakbara/simple-ecommerce

```

```bash

$ cd simple-ecommerce

```

```bash

$ npm install

```

## Configuration

Copy the .env.example and rename it to .env.

```bash

$ cp .env.example .env

```

Change the config for your local server.

```bash

DB_HOST="localhost"

DB_PORT=3306

DB_USER="root"

DB_PASSWORD=""

DB_DATABASE="ecommerce_db_v1"

DB_DIALECT="mysql"

JWT_SECRET="this-is-secret"

JWT_EXPIRATION="1h"

```

## Migration

Run the migration.

```bash

$ npm run db:migrate

```

Run the seeder.

```bash

$ npm run db:seed

```

## Running Local Development Server

_this will run server with nodemon enabled_

```bash

$ npm run dev

```