README.md

TypeScript GitHub Tools

Tools used for setting up a repository.

• create
  • labels
    • npm dependencies
    • github action
    • code quality
  • secret
    • CC_TEST_REPORTER_ID
    • CODACY_PROJECT_TOKEN

API Docs

Features

• TypeScript
• Jest Unit Tests with Code Coverage
• API Docs Generation
• GitHub CI Integration (feature, development, master, release)
• Travis Integration
• CircleCI Integration
• AppVeyor Integration
• Code Quality via Code Climate and Codacy

GitHub	CircleCI	AppVeyor	Coveralls

Example

npm start [owner]/[repo] [CC_TEST_REPORTER_ID] [CODACY_PROJECT_TOKEN]

Clone repository

git clone https://github.com/gregoranders/ts-github-tools

Install dependencies

npm install

Build

npm run build

Testing

Test using Jest

npm test

Code Climate Checks docker required

npm run codeclimate

Codacy Checks docker required

npm run codacy

Run

npm start

Clear

npm run clear