Skip to content

Commit

Permalink
Merge pull request #27 from javieraviles/develop
Browse files Browse the repository at this point in the history
Updating libs: dotenv, class-validator and Winston
  • Loading branch information
javieraviles authored Aug 18, 2018
2 parents 8c6adf2 + ede170c commit 7dc8460
Show file tree
Hide file tree
Showing 5 changed files with 214 additions and 68 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Dependency Status](https://david-dm.org/javieraviles/node-typescript-koa-rest.svg)](https://david-dm.org/javieraviles/node-typescript-koa-rest)
[![Build Status](https://travis-ci.org/javieraviles/node-typescript-koa-rest.svg?branch=develop)](https://travis-ci.org/javieraviles/node-typescript-koa-rest)


The main purpose of this repository is to build a good project setup and workflow for writing a Node api rest in TypeScript using KOA and an SQL DB.

Koa is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs. Through leveraging generators Koa allows you to ditch callbacks and greatly increase error-handling. Koa does not bundle any middleware within core, and provides an elegant suite of methods that make writing servers fast and enjoyable.
Expand All @@ -28,6 +29,7 @@ AVAILABLE ENDPOINTS
| `PUT` | `/users/:id` | updates an already created user in the DB (object user to be includued in request's body) |
| `DELETE` | `/users/:id` | deletes a user from the DB (JWT token user ID must be the same as the user you want to delete) |


## Pre-reqs
To build and run this app locally you will need:
- Install [Node.js](https://nodejs.org/en/)
Expand Down Expand Up @@ -358,3 +360,23 @@ In that file you'll find two sections:
| shelljs | Portable Unix shell commands for Node.js |

To install or update these dependencies you can use `npm install` or `npm update`.


## Changelog

### 1.4.0
- Dotenv lib updated, no changes needed (they are dropping node4 support)
- Class-validator lib updated, no chages needed (cool features added like IsPhoneNumber or custom context for decorators)
- Winston lib updated to 3.0.0, some amendments needed to format the console log. Removed the @types as Winston now supports Typescript natively!

### 1.3.0
- CORS added
- Syntax full REST
- Some error handling improvement

### 1.2.0
- Heroku deployment added

### 1.1.0
- Added Helmet for security
- Some bad practices await/async fixed
Loading

0 comments on commit 7dc8460

Please sign in to comment.