Skip to content

vkottler/typescript-package-template

Repository files navigation

typescript-package-template

Build Status

This is a template intended to be used with Cookiecutter.

Usage

Invoke cookiecutter and fill out information about your project:

$ cookiecutter git@github.com:vkottler/typescript-package-template.git
name [Vaughn Kottler]: <Your Name>
project_name [package-name]: <your-project-name>
description: [Short project description.]: <Your project's description.>
...

Structure

$ tree -a -I venv*|__pycache__|*cov*|*-out|config|build|tags|.git*|.*cache*|node_modules -- package-name

package-name
├── .eslintrc.cjs
├── jest.config.js
├── LICENSE
├── local
│   ├── configs
│   │   ├── html.yaml
│   │   ├── license.yaml
│   │   ├── node.yaml
│   │   └── package.yaml
│   ├── templates
│   │   ├── app.html.j2
│   │   └── README.md.j2
│   └── variables
│       └── html.yaml
├── Makefile
├── manifest.yaml
├── package.json
├── package-lock.json
├── package-name -> src
├── README.md
├── src
│   ├── dev_requirements.txt
│   ├── favicon.ico
│   ├── index.css
│   ├── index.html
│   ├── index.ts
│   ├── requirements.txt
│   └── ts
│       └── App.ts
├── tasks
│   ├── conf.py
│   └── __init__.py
├── tests
│   └── App.test.ts
├── tsconfig.json
└── .vimrc

9 directories, 27 files

Platform Support

This template is tested on the following platforms:

  • windows-latest
  • macos-latest
  • ubuntu-latest