Skip to content

lenneTech/typescript-starter

Repository files navigation

TypeScript Starter

The lenne.Tech TypeScript Starter helps to initialize your next TypeScript project extremely fast. For example, it is ideal for creating a new npm package.

License CircleCI Dependency Status devDependency Status

Requirements

  • Node.js incl. npm:
    the runtime environment for your TypeScript project

  • Git:
    the version control system for your source code

Initialization

Via CLI (recommended)

$ npm install -g @lenne.tech/cli
$ lt ts new <project-name>
$ cd <project-name>
$ npm test
$ npm start

Installation via the CLI is recommended, as automated adjustments are made to the configuration for the respective project, so that you can start development directly and spend as little time as possible on configuring the development environment.

Via GitHub

$ git clone https://github.com/lenneTech/typescript-starter.git <project-name>
$ cd <project-name>
$ npm test
$ npm start

After the installation via GitHub it is recommended to adjust package.json and README.md directly.

Update packages

For regular control and easy update of new npm packages you can use e.g. npm-check-updates.

Alternative recommendations for specific purposes

Create a new CLI or shell script

For the creation of a new CLI or a shell script we recommend Gluegun. To create a new CLI with the help of Gluegun we built the CLI Starter.

Create a new server

So that you can quickly set up a server with database connection and GraphQL API via NestJS, we have developed the lenne.Tech Nest Server Starter for you.

License

MIT - see LICENSE