https://github.com/lennetech/typescript-starter
Starter for TypeScript projects
https://github.com/lennetech/typescript-starter
Last synced: 8 months ago
JSON representation
Starter for TypeScript projects
- Host: GitHub
- URL: https://github.com/lennetech/typescript-starter
- Owner: lenneTech
- License: mit
- Created: 2019-09-01T18:10:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T08:41:58.000Z (over 3 years ago)
- Last Synced: 2024-12-30T09:31:40.891Z (over 1 year ago)
- Language: TypeScript
- Size: 220 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Starter
The [lenne.Tech](https://github.com/lenneTech) TypeScript Starter helps to initialize your next [TypeScript](https://www.typescriptlang.org/) project extremely fast.
For example, it is ideal for creating a new npm package.
[](/LICENSE) [](https://circleci.com/gh/lenneTech/typescript-starter/tree/master)
[](https://david-dm.org/lenneTech/typescript-starter) [](https://david-dm.org/lenneTech/typescript-starter?type=dev)
## Requirements
- [Node.js incl. npm](https://nodejs.org):
the runtime environment for your TypeScript project
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git):
the version control system for your source code
## Initialization
### Via [CLI](https://github.com/lenneTech/cli) (recommended)
```
$ npm install -g @lenne.tech/cli
$ lt ts new
$ cd
$ 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
$ cd
$ 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](https://github.com/tjunnone/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](https://github.com/infinitered/gluegun).
To create a new CLI with the help of Gluegun we built the [CLI Starter](https://github.com/lenneTech/cli-starter).
### Create a new server
So that you can quickly set up a server with database connection and GraphQL API via [NestJS](https://nestjs.com/), we have developed the lenne.Tech [Nest Server Starter](https://github.com/lenneTech/nest-server-starter) for you.
## License
MIT - see LICENSE