Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.35 KB

README.md

File metadata and controls

54 lines (40 loc) · 1.35 KB

jboilerplate-cli

jboilerplate is a TypeScript-based server boilerplate designed for quick project setup using the tsx runtime for fast, lightweight execution. This boilerplate includes essential configurations for setting up an Express server, with linting, environment management, and TypeScript support right out of the box.

Features

  • Express: Set up a basic Express server.
  • TypeScript: Fully configured TypeScript support.
  • TSX: Fast TypeScript runtime for node.js, allowing for quick execution without pre-compilation.
  • Prettier and ESLint: Code formatting and linting for consistent code style.
  • Dotenv: Support for environment variables.

Installation

To install this boilerplate, simply run:

npm i -g jboilerplate

jboiler <your package name>

Directory

Open your directory

cd <your package name>

//install node packages
npm install

//start developement
npm start

Tree

├── eslint.config.mjs
├── package-lock.json
├── package.json
├── src
│   ├── handler
│   │   └── main.handler.ts
│   ├── index.ts
│   ├── middleware
│   │   └── middleware.server.ts
│   ├── routes
│   │   └── route.server.ts
│   └── server
│       └── server.ts
└── tsconfig.json