Skip to content

Commit 47c4da5

Browse files
authored
Update README.md
1 parent eea1a8a commit 47c4da5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

API_MySQL_AWS/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,23 @@
22

33
At the conception of this sample project, the REST API app was kept alive using PM2 on an AWS EC2. The MySQL was an instance created in AWS RDS.
44

5+
## Tech Highlights
6+
**MySQL Driver:** The node module [`mysql`](https://github.com/mysqljs/mysql#readme)
7+
8+
**REST Framework:** Restify
9+
10+
**Authentication:** JsonWebToken
11+
12+
513
**For this latest version:**
614
1. I integrated JWT for API Authentication.
715
2. Re-scaffold the routes and data files.
816
3. I did not use async/await syntax, and instead, I kept Callbacks and Promise functions because I was being nostalgic of the old days. If you'd like to see me apply async/await used in REST API, take a look at the [API_MongoDB_Atlas](https://github.com/junerockwell/REST_NodeJS_API_Samples/tree/master/API_MongoDB_Atlas) folder. MongooseJS added the async/await features so it was a given.
917
4. Added proper error handlings using `restify-errors`
1018

19+
**Alternatives to the `mysql` driver**
20+
[Sequelize](https://github.com/sequelize/sequelize) is an ORM and a good alternative to `mysql` driver. In this project, I use only `mysql` which expects SQL Statements. However, with Sequelize, you don't make SQL Statements. It's beneficial to use Sequelize because it handles many SQL-DB like MSSQL Server, MariaDB and especially MySQL.
21+
1122
### Create the Database
1223
**1. Remote MySQL DB on Amazon RDS:** https://aws.amazon.com/getting-started/hands-on/create-mysql-db/
1324

0 commit comments

Comments
 (0)