TS-BoilerplateX

TS-BoilerplateX is a meticulously crafted boilerplate tailored for developers seeking a seamless starting point for building powerful web applications with TypeScript and Express.js. With TS-BoilerplateX, harness the combined benefits of TypeScript's static typing and Express.js' flexibility to expedite your development process while ensuring code integrity and maintainability.

Starting off

I've documented my process and highlighted the main components in this article. If you're eager to dive into the code right away, you can head straight to the repository:github

Features

• TypeScript support
• Express.js integration
• ESLint for code linting
• Example controllers and routes
• Comprehensive documentation
• EditorConfig for consistent coding style

Installation

To quickly create an application skeleton, you can utilize the TS-BoilerplateX tool. You can run the application generator using the npx command.

npx ts-boilerplatex

To install TS-BoilerplateX, you can use npm:

npm install ts-boilerplatex

-> dev: Start the development server with nodemon.
-> start: Start the application using ts-node to execute src/main.ts.
-> lint: Run ESLint to lint source files in the src/ directory.
-> docs: Generate documentation using Typedoc from src/main.ts.
-> build: Compile TypeScript files using the TypeScript compiler (tsc) based on the tsconfig.json configuration.
-> build-all: Clean the build directory, then run build, esbuild-node, and esbuild-browser scripts.
-> clean: Remove build artifacts and generated documentation.

Project Structure

The project structure is organized as follows:

TS-BoilerplateX/
|-- bin/
|   -- server.ts
|-- controller/
|   -- indexController.ts
|-- routes/
|   -- index.ts
|-- README.md
|-- package.json
|-- tsconfig.json
`-- ...

• bin/: Contains the server configuration.
• controller/: Contains controller functions to handle route logic.
• routes/: Contains route definitions.

Middleware

• Morgan Morgan middleware is used for logging HTTP requests. It's configured to log requests in the "dev" format.
• bodyParser bodyParser middleware is used to parse incoming JSON and URL-encoded requests. It's configured to handle JSON and URL-encoded requests with extended mode enabled.
• compression compression middleware compresses HTTP responses before sending them to the client.
• cookieParser cookieParser middleware is used to parse cookies attached to incoming requests.