npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-generator-typescript

v2.4.10

Published

Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead

Downloads

5,361

Readme

Express with TypeScript's application generator.

What is it?

Creates a new express application similar to the express-generator module. Except this new application is configured to use TypeScript instead of plain JavaScript.

This project complies with Typescript best practices listed here.

Why express-generator-typescript?

NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. TypeScript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like Java.

There are some other tools out there to generate express apps with TypeScript such as express-generator-ts, but these either haven't been updated in a while or install a lot of junk in your project (such as an ORM).

Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you need to run for development (while restarting on changes), building, testing, and running for production are packaged with this library.

In addition, relative paths are also setup, so you don't have to go through the trouble of installing and configuring tsconfig-paths and module-alias. Just make sure to update paths in tsconfig.json and _moduleAliases in package.json if you want to add/edit the relative paths.

Sample-project

When you run express-generator-typescript, it sets up a simple application with routes for adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done with express.

If you want a fully-secure application, you can pass the --with-auth option and you will have an application which requires you to login before calling APIs on user objects. The app is configured with production quality client-side security and uses signed-cookies and jsonwebtokens to store user-session data. If you're new to web-development and still learning about securing websites, I highly encourage to use this option.

Installation

$ Just use 'npx'
  Or
$ npm install -g express-generator-typescript

Quick Start

The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default express-gen-ts will be used instead. If you want to use yarn instead of npm, pass the option --use-yarn.

Create the app: With no options: $ npx express-generator-typescript With all options (order doesn't matter): $ npx express-generator-typescript --with-auth --use-yarn "project name"

Start your express-generator-typescript app in development mode at http://localhost:3000/:

$ cd "project name" && npm run dev

Available commands for the server.

  • Run the server in development mode: npm run dev.
  • Run all unit-tests with hot-reloading: npm test.
  • Run a single unit-test: npm test -- --testFile="name of test file" (i.e. --testFile=Users).
  • Run all unit-tests without hot-reloading: npm run test:no-reloading
  • Check for linting errors: npm run lint.
  • Build the project for production: npm run build.
  • Run the production build: npm start.
  • Run production build with a different env file npm start -- --env="name of env file" (default is production).

Debugging

During development, express-generator-typescript uses nodemon to restart the server when changes are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations. This is located under nodemonConfig: in package.json for the server and ./spec/nodemon.json for unit-testing. For the exec property, replace ts-node with node --inspect -r ts-node/register.

Note for VS-Code users

A lot of users have asked about launch.json configurations for running this in VS-Code, so here's a snippet of the launch.json configuration you need to bypass nodemon and run directly with VS-Code.

  {
        "type": "pwa-node",
        "request": "launch",
        "name": "Debug Dev Env",
        "runtimeArgs": [
            "-r",
            "ts-node/register",
            "-r",
            "tsconfig-paths/register",
        ],
        "args": [
            "${workspaceFolder:express-gen-ts}/src/index.ts"
        ],
        "resolveSourceMapLocations": [
            "${workspaceFolder}/**",
            "!**/node_modules/**"
        ],
   }

Note for windows users

If you are on Windows, the bcrypt module tends to be fussy. To use this module on Windows you need to make sure you have the node Windows build tools installed. I don't want to post instructions because they might change frequently. I would search the Microsoft docs on how to setup Node for Windows. To be able to debug in VSCODE on windows I also had to install the node-gyp module globally as well.

Happy web deving :)

License

MIT