express-restfulAPI-clean-architecture

Description

vincent-express-api-system

Installation

1. Clone the repository:

   git clone <repository-url>

2. Install dependencies:

   npm install

Usage

To start the development server, run:

npm run dev

Scripts

• dev: Starts the development server using nodemon.
• gen:flop: Generates code using Plop.
• typecheck: Runs TypeScript type checking.
• lint: Lints the code using ESLint.
• lint:fix: Fixes linting issues automatically.
• prettify: Formats the code using Prettier.
• format: Formats all code files (JavaScript, TypeScript, JSON, and Markdown).
• format:js: Formats JavaScript and TypeScript files.
• format:json: Formats JSON files.
• format:md: Formats Markdown files.
• format:ts: Formats TypeScript files.

Dependencies

• @types/express-serve-static-core: TypeScript types for Express.
• @typescript-eslint/eslint-plugin: ESLint plugin for TypeScript.
• @typescript-eslint/parser: Parser for TypeScript ESLint.
• body-parser: Middleware for parsing request bodies.
• crypto: Cryptography library for Node.js.
• dotenv: Loads environment variables from a .env file.
• express: Web framework for Node.js.
• express-validator: Middleware for request validation in Express.
• pg: PostgreSQL client for Node.js.
• postgres: PostgreSQL driver for Node.js.
• typeorm: ORM for TypeScript and JavaScript.

Dev Dependencies

• @types/body-parser: TypeScript types for body-parser.
• @types/express: TypeScript types for Express.
• @types/node: TypeScript types for Node.js.
• @types/nodemon: TypeScript types for nodemon.
• @types/pg: TypeScript types for pg.
• eslint: JavaScript linter.
• nodemon: Utility to restart the server when files change.
• plop: Code generator.
• prettier: Code formatter.
• ts-node: TypeScript execution environment and REPL for Node.js.
• typescript: JavaScript superset language.