Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdacasserole/typescript-project-template
A TypeScript project template all set up with a build system, testing framework etc.
https://github.com/lambdacasserole/typescript-project-template
chai gulp mocha npm template typedoc typescript
Last synced: about 1 month ago
JSON representation
A TypeScript project template all set up with a build system, testing framework etc.
- Host: GitHub
- URL: https://github.com/lambdacasserole/typescript-project-template
- Owner: lambdacasserole
- License: unlicense
- Created: 2020-10-03T11:33:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-03T11:54:48.000Z (over 4 years ago)
- Last Synced: 2024-11-01T09:28:23.713Z (3 months ago)
- Topics: chai, gulp, mocha, npm, template, typedoc, typescript
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Project Template
A TypeScript project template all set up with a build system, testing framework etc.
## Overview
I got pretty tired of setting up my preferred TypeScript dev stack every time I start a new project, so I put this repo together. Also I really want to try out GitHub's template repository feature.
## Components
This project template is set up and ready to go with:
* The [Gulp](https://gulpjs.com/) streaming build system.
* Testing that uses [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
* The [TypeDoc](http://typedoc.org/) documentation generator.
* Obviously, the [TypeScript](https://www.typescriptlang.org/) compiler.
## Usage
This project will allow you to build, test and document some example code straight away.
### Prerequisites
You'll need to be set up with [node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/). You probably also want to set up [Gulp](https://gulpjs.com/) globally so you can just type `gulp` on the command line to build etc. Briefly, you probably want to do one of these:
```bash
npm install --global gulp-cli
```
Don't forget to run an `npm install` to get your `node_modules` directory set up initially.
### Building
Building is handled via Gulp.
```bash
gulp build
```
You can also run the following before the above if you'd like to run a clean build:
```bash
gulp clean
```
### Generating Docs
Documentation generation is handled via Gulp.
```bash
gulp docs
```
### Running Tests
Running tests is currently *not* handled via Gulp, but npm. I just kept tripping over the tooling and things worked out easier this way.
```bash
npm test
```
All of the above should run out of the box, because there's some sample code in there already.
## Watch Tasks
There is a watch task included in the gulpfile, which will trigger whenever a `*.ts` file in `/src` or any of its subdirectories is modified. Run this while you're developing your code:
```bash
gulp watch
```
## Acknowledgements
The maintainers of all the tooling used in this project deserve serious props for building some amazing software.