Express TypeScript Starter

A starter template for building robust TypeScript Express backends.

Features

• TypeScript backend using Express
• Modern dev workflow with tsx
• Linting with ESLint and formatting with Prettier
• Pre-commit and pre-push hooks powered by Husky and lint-staged
• Ready for VSCode with recommended extensions and workspace settings

Getting Started

Prerequisites

• Node.js (v18+ recommended)
• npm

Installation

1. Clone the repo:

   git clone https://github.com/adonisote/express-typescript-starter.git
   cd express-typescript-starter

2. Install dependencies:

   npm install

3. (Optional) Enable Husky hooks:

   npm run prepare

Development

Run in development mode

npm run dev

• Starts the server with hot-reloading via tsx.

Build for production

npm run build

• Compiles TypeScript to the dist directory.

Start in production

npm start

• Runs the compiled JavaScript from dist.

Code Quality

Lint

npm run lint

Lint & auto-fix

npm run lint:fix

Format check

npm run format

Format & auto-fix

npm run format:fix

Testing

Note: Tests are not yet implemented.
Placeholder command:

npm test

Husky Git Hooks

• pre-commit: Runs lint-staged (ESLint + Prettier on staged files)
• pre-push: Runs tests before pushing (aborts on failure)
• post-commit/post-push: Friendly notifications

VSCode

Recommended extensions are in .vscode/extensions.json:

• ESLint
• Prettier

Workspace settings are in .vscode/settings.json.

Project Structure

├── src/              # Source code
│   └── index.ts      # Entry point
├── dist/             # Compiled output (ignored)
├── .husky/           # Git hooks
├── .vscode/          # VSCode settings
├── package.json
├── tsconfig.json
├── eslint.config.js
├── .prettierrc
├── .prettierignore
├── .gitignore
└── README.md

Contributing

1. Open an issue describing your idea or bug.
2. Create a feature/fix branch:
   git checkout -b issue-<number>-<short-description>
3. Commit your changes with descriptive messages.
4. Push and open a Pull Request referencing the issue (Closes #<number>).
5. Wait for review and merge!

License

ISC

Happy coding!