Giter Club home page Giter Club logo

lib-template's Introduction

lib-template

A template for new open source libraries written in TypeScript.

Table of contents

How to use this

First, create a new repository based on this template by clicking the green Use this template button on the GitHub repository homepage. Clone your new repository and run this in a terminal:

$ ./init.sh

GitHub configuration

  • GitHub configuration is updated automatically if you install the Settings app
  • PR's are merged automatically if you install probot-auto-merge
  • Monitor the code quality with CodeClimate. Replace <code_climate_reporter_id> in .github/workflows/ci.yaml with the Test Reporter ID obtained from CodeClimate (navigate to Repo Settings > Test coverage).
  • Auto-release by using semantic-release. Create these repository secrets:
    • NPM_TOKEN: Enter a NPM access token with Read and Publish permission to publish your package to NPM.
    • GH_TOKEN: Enter a GitHub Personal Acces Token with repo permission. This is needed to circumvent branch protection rules when adding release commits.

Done! ๐ŸŽ‰

lib-template's People

Contributors

hongaar avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.