Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeroonedev01/express-simple-crud-with-sequelize-orm
https://github.com/zeroonedev01/express-simple-crud-with-sequelize-orm
Last synced: about 16 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/zeroonedev01/express-simple-crud-with-sequelize-orm
- Owner: zeroonedev01
- Created: 2019-10-29T02:24:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-01T06:09:50.000Z (almost 5 years ago)
- Last Synced: 2023-12-28T11:47:20.780Z (11 months ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
Simple REST API
Built with Express.js,Mysql, and Sequalize.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Features](#features)
- [Built With](#built-with)
- [Requirements](#requirements)
- [Installation](#installation)
- [Setup .env file](#setup-env-file)
- [Plugins](#plugins)
- [API Route URL (Public)](#api-route-url-public)
- [Companies](#companies)
- [Employees](#employees)
- [Deploy](#deploy)
- [Contributor](#contributor)
## Introduction
Lorem Ipsum
## Features
> - CRUD Employees
> - CRUD Companies
> - Sequalize ORM
> - cache
## Built With
[](https://expressjs.com/)
[](https://sequelize.org/)
[](https://www.npmjs.com/search?q=mysql)
[](https://www.npmjs.com/package/bcryptjs)
## Requirements
> - Node.js - Download and Install Node.js - Simple bash script to manage multiple active node.js versions.
> - npm
> - Nodemon - Download and Install Nodemon - nodemon is a tool that automatically restarting the node application when file changes in the directory are detected.
> - postman (installer or chrome extension)
> - code editor (visual studio code recommend)
> - mysql (xampp)
## Installation
Install the dependencies, migrate, start the server.
```sh
$ git clone https://github.com/tejojr/Express-Simple-CRUD-with-Sequelize-ORM.git
$ cd Express-Simple-CRUD-with-Sequelize-ORM
$ npm install
$ npm start
```
\*\*migrate durung
## Setup .env file
- In windows OS, you can open command prompt, change directory to your project directory.
Example,
My project directory
```
E:\my_project
```
- Then you can type,
```
copy .env.example .env
```
- Then Setup .env
## Plugins
| Plugin | Version |
| --------------- | ------- |
| bcryptjs | ^2.4.3 |
| body-parser | ^1.19.0 |
| cors | ^2.8.5 |
| express | ^4.17.1 |
| dotenv | ^8.2.0 |
| morgan | ^1.9.1 |
| mysql2 | ^2.0.0 |
| redis | ^2.8.0 |
| node-redis-scan | ^1.1.0 |
| sequalize | ^5.21.1 |
## API Route URL (Public)
### Companies
| Plugin | Purpose | Method |
| --------------------- | ------------------ | ------ |
| /api/v1/companies | Insert Company | POST |
| /api/v1/companies/:id | Update Company | PATCH |
| /api/v1/companies/:id | Delete Company | DELETE |
| /api/v1/companies/ | Select All Company | GET |
| /api/v1/companies/:id | Select by ID | GET |
### Employees
| Plugin | Purpose | Method |
| --------------------- | ------------------- | ------ |
| /api/v1/employees | Insert Employee | POST |
| /api/v1/employees/:id | Update Employee | PATCH |
| /api/v1/employees/:id | Delete Employee | DELETE |
| /api/v1/employees/ | Select All Employee | GET |
| /api/v1/employees/:id | Select by ID | GET |
## Deploy
> - heroku : https://sequalizecrud.herokuapp.com/api/v1/
> - aws : http://ec2-18-234-185-164.compute-1.amazonaws.com:3000/api/v1
## Contributor
