Skip to content

Commit 1e93496

Browse files
committed
📖 DOC: Updated
1 parent 42f8cba commit 1e93496

File tree

2 files changed

+4
-14
lines changed

2 files changed

+4
-14
lines changed

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
66
- Node
77
- Typescript
88
- Express
9-
- MySql
9+
- Sequelize (Oracle, Postgres, MySQL, MariaDB, SQLite and SQL Server etc.)
1010

1111
## Table of Contents
1212

@@ -21,14 +21,14 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
2121
- [Project Structure](#project-structure)
2222
- [API Documentation](#api-documentation)
2323
- [API Endpoints](#api-endpoints)
24-
- [Linting](#linting)
2524
- [Inspirations](#inspirations)
2625

2726

2827

2928
## Quick start
3029

3130
create boillerplate with single command
31+
3232
```
3333
npx @nabadeep25/create-ts-node-app myapp
3434
@@ -133,6 +133,7 @@ npm run format
133133
## Project Structure
134134

135135
```
136+
dist\ # js files
136137
src\
137138
|--config\ # Environment variables and configuration related things
138139
|--controllers\ # Route controllers
@@ -167,17 +168,6 @@ List of available routes:
167168
`PATCH api/v1/user` - update user\
168169

169170

170-
## Linting
171-
172-
Linting is done using [ESLint](https://eslint.org/) and [Prettier](https://prettier.io).
173-
174-
In this app, ESLint is configured to follow the [Airbnb JavaScript style guide](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) with some modifications. It also extends [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to turn off all rules that are unnecessary or might conflict with Prettier.
175-
176-
To modify the ESLint configuration, update the `.eslintrc.json` file. To modify the Prettier configuration, update the `.prettierrc.json` file.
177-
178-
To prevent a certain file or directory from being linted, add it to `.eslintignore` and `.prettierignore`.
179-
180-
To maintain a consistent coding style across different IDEs, the project contains `.editorconfig`
181171

182172

183173

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nabadeep25/create-ts-node-app",
3-
"version": "0.1.3",
3+
"version": "0.1.5",
44
"description": "",
55
"author": "Nabadeep Thakuria",
66
"bin": "bin/cli.js",

0 commit comments

Comments
 (0)