Skip to content

ahmadu2305/express-pug-typescript-starter

Repository files navigation

Express Pug TypeScript Starter

GitHub last commit GitHub license Node.js Version Built with GitHub Copilot CI npm GitHub issues GitHub pull requests GitHub contributors GitHub forks GitHub stars

Description

A starter template for building web applications using Express, Pug, and TypeScript. This project provides a simple structure for rapid development and easy customization.

Table of Contents

Installation

  1. Clone the repository:
git clone https://github.com/your-username/your-repo.git
cd your-repo
  1. Install dependencies:
npm install
  1. Build the TypeScript code:
npm run build

Usage

  • To start the development server:
    npm run dev
  • To start the application in production mode:
    npm start
  • Open your browser and navigate to http://localhost:3000.

Folder Structure

.
├── src
│   ├── app.ts          # Entry point of the application
│   ├── routes          # Route definitions
│   └── views           # Pug templates
├── package.json        # NPM configuration file
├── tsconfig.json       # TypeScript configuration file
└── README.md           # Project documentation

Features

  • Express server setup with TypeScript
  • Pug template engine for rendering views
  • Example route and view
  • Easy project structure for scaling

Configuration

  • Edit src/app.ts to add routes or middleware.
  • Pug templates are located in the src/views directory.
  • Update TypeScript settings in tsconfig.json as needed.

License

This project is licensed under the MIT License.


Built with GitHub Copilot

#builtwithgithubcopilot is a campaign for participants to share products built with GitHub Copilot, to gain visibility.

About

A starter template for Node.js, Express, Pug, and TypeScript web apps

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published