Code Monkey home page Code Monkey logo

ts-library-template's Introduction

ts-library-template

CI/CD Coverage Status Prettier Commitizen friendly semantic-release typedoc parcel Depfu

This is an example of scaffolding for a library using TypeScript and Parcel.

IMPORTANT: The placeholders must be replaced with their actual values, please change occurrences of:

  • AndresCalimero (GitHub user) and ts-library-template (repo name) in README.md
  • ts-library-template with the name of the library in package.json
  • @andrescalimero with the GitHub username in lowercase in package.json
  • AndresCalimero (GitHub user), ts-library-template (repo name), Andres Calimero (author name) and [email protected] (author email) in package.json
  • Andres Calimero (author name) and 2020 (year) in LICENSE
  • AndresCalimero (GitHub user) and ts-library-template (repo name) in CONTRIBUTING.md

Configuration

Auto publish

Due to limitations in GitHub Actions you have to provide a GitHub PAT (Personal Access Token) if you want to publish the library and the documentation automatically on every release, to provide the PAT you have to set the variable ACCESS_TOKEN in your repository's secrets with the token as the value. The token should have access to the repo scope.

Publishing to NPM

If you want your library to be published to NPM automatically you must set the variable NPM_TOKEN in your repository's secrets. It should be a valid NPM personal token with the right permissions.

ts-library-template's People

Contributors

andrescalimero avatar semantic-release-bot 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.