You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-13Lines changed: 3 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
6
6
- Node
7
7
- Typescript
8
8
- Express
9
-
-MySql
9
+
-Sequelize (Oracle, Postgres, MySQL, MariaDB, SQLite and SQL Server etc.)
10
10
11
11
## Table of Contents
12
12
@@ -21,14 +21,14 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
21
21
-[Project Structure](#project-structure)
22
22
-[API Documentation](#api-documentation)
23
23
-[API Endpoints](#api-endpoints)
24
-
-[Linting](#linting)
25
24
-[Inspirations](#inspirations)
26
25
27
26
28
27
29
28
## Quick start
30
29
31
30
create boillerplate with single command
31
+
32
32
```
33
33
npx @nabadeep25/create-ts-node-app myapp
34
34
@@ -133,6 +133,7 @@ npm run format
133
133
## Project Structure
134
134
135
135
```
136
+
dist\ # js files
136
137
src\
137
138
|--config\ # Environment variables and configuration related things
138
139
|--controllers\ # Route controllers
@@ -167,17 +168,6 @@ List of available routes:
167
168
`PATCH api/v1/user` - update user\
168
169
169
170
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`
0 commit comments