09 Readme - jp7io/typescript-crud-api GitHub Wiki

Readme

Create README.md

code ./README.md
# TypeScript CRUD API (Backend)

#### A guide to build a TypeScript CRUD API (Backend) with TypeORM.

####  Live Demo

* This API: https://typescript-crud-api.herokuapp.com
* Frontend: https://jp7internet.github.io/typescript-crud

#### Step-by-Step Tutorial

https://github.com/jp7internet/typescript-crud-api/wiki

#### Screenshots

| Swagger | Entities |
| ------------- | ------------- |
| ![Swagger](https://github.com/jp7internet/typescript-crud-api/wiki/images/swagger.png) | ![Swagger](https://github.com/jp7internet/typescript-crud-api/wiki/images/entities.png) |

https://github.com/jp7internet/typescript-crud-api/wiki/Screenshots

#### Includes

* Typescript
* Express Restful CRUD
* TypeORM
* Associations
* Validations
* Rate Limit
* Seed
* Documentation with Swagger
* Deploy with Heroku

Add README to Git

git add .
git commit -m "Readme"

Next step: Deploy