From 1e934966be3d94d365406c824ab42e962609d9b9 Mon Sep 17 00:00:00 2001 From: Nabadeep Date: Sat, 17 Dec 2022 11:40:42 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20DOC:=20Updated?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 +++------------- package.json | 2 +- 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2f49332..c096669 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty - Node - Typescript - Express -- MySql +- Sequelize (Oracle, Postgres, MySQL, MariaDB, SQLite and SQL Server etc.) ## Table of Contents @@ -21,7 +21,6 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty - [Project Structure](#project-structure) - [API Documentation](#api-documentation) - [API Endpoints](#api-endpoints) - - [Linting](#linting) - [Inspirations](#inspirations) @@ -29,6 +28,7 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty ## Quick start create boillerplate with single command + ``` npx @nabadeep25/create-ts-node-app myapp @@ -133,6 +133,7 @@ npm run format ## Project Structure ``` +dist\ # js files src\ |--config\ # Environment variables and configuration related things |--controllers\ # Route controllers @@ -167,17 +168,6 @@ List of available routes: `PATCH api/v1/user` - update user\ -## Linting - -Linting is done using [ESLint](https://eslint.org/) and [Prettier](https://prettier.io). - -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. - -To modify the ESLint configuration, update the `.eslintrc.json` file. To modify the Prettier configuration, update the `.prettierrc.json` file. - -To prevent a certain file or directory from being linted, add it to `.eslintignore` and `.prettierignore`. - -To maintain a consistent coding style across different IDEs, the project contains `.editorconfig` diff --git a/package.json b/package.json index fa9b884..42a01af 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@nabadeep25/create-ts-node-app", - "version": "0.1.3", + "version": "0.1.5", "description": "", "author": "Nabadeep Thakuria", "bin": "bin/cli.js",