Skip to content

📖 DOC: Updated #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 17, 2022
+4 −14
Merged

📖 DOC: Updated #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -21,14 +21,14 @@ 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)



## Quick start

create boillerplate with single command

```
npx @nabadeep25/create-ts-node-app myapp

Expand Down Expand Up @@ -133,6 +133,7 @@ npm run format
## Project Structure

```
dist\ # js files
src\
|--config\ # Environment variables and configuration related things
|--controllers\ # Route controllers
Expand Down Expand Up @@ -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`



Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down