Skip to content

Commit

Permalink
add deploy link
Browse files Browse the repository at this point in the history
  • Loading branch information
zeroonedev01 committed Nov 11, 2019
1 parent 69fa9ea commit 6a249d1
Showing 1 changed file with 27 additions and 16 deletions.
43 changes: 27 additions & 16 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
</p>

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Features](#features)
Expand All @@ -23,55 +24,61 @@
- [Contributor](#contributor)

## Introduction

Lorem Ipsum

## Features

> - CRUD Employees
> - CRUD Companies
> - Sequalize ORM
> - cache
## Built With

[![Express](https://img.shields.io/badge/Express%20-v.4.17.1-green.svg?style=rounded-square)](https://expressjs.com/)
[![Sequalize](https://img.shields.io/badge/Sequalize-v.5.21.1-blue.svg?style=rounded-square)](https://sequelize.org/)
[![MySQL2](https://img.shields.io/badge/MySQL2-v.2.0.0-orange.svg?style=rounded-square)](https://www.npmjs.com/search?q=mysql)
[![MySQL2](https://img.shields.io/badge/MySQL2-v.2.0.0-orange.svg?style=rounded-square)](https://www.npmjs.com/search?q=mysql)
[![bcryptjs](https://img.shields.io/badge/bcryptjs-v.2.4.3-critical)](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)

> - 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

\*\*migrate durung

## Setup .env file
* In windows OS, you can open command prompt, change directory to your project directory.
Example,
My project directory

- 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,
- Then you can type,
```
copy .env.example .env
```
* Then Setup .env
- Then Setup .env

## Plugins


| Plugin | Version |
| --------------- | ------- |
| bcryptjs | ^2.4.3 |
Expand All @@ -86,7 +93,9 @@ My project directory
| sequalize | ^5.21.1 |

## API Route URL (Public)

### Companies

| Plugin | Purpose | Method |
| --------------------- | ------------------ | ------ |
| /api/v1/companies | Insert Company | POST |
Expand All @@ -106,10 +115,12 @@ My project directory
| /api/v1/employees/:id | Select by ID | GET |

## Deploy
heroku :
aws :

> - heroku : https://sequalizecrud.herokuapp.com/api/v1/
> - aws : maintenance
## Contributor

<a href="https://github.com/tejojr">
<img width="100" src="https://avatars2.githubusercontent.com/u/33275770?s=460&v=4" alt="Ammar Annajih Pasifiky">
<br/>
Expand Down

0 comments on commit 6a249d1

Please sign in to comment.