Giter Club home page Giter Club logo

npm-library-template's Introduction

Template for my NPM libraries

Hello, everyone! This is a template repo for my libraries. You'll find a readme template inside this file.

In order for the CI workflow's publishing jobs to execute successfully, you must have two Actions secrets set up -- NPM_AUTH_TOKEN and GPR_AUTH_TOKEN.

You might want to check the YAML Actions workflow for hints and information you may want or need to know.

Template features

  • License (both template contents and code built from it): MIT.

  • Code of conduct: adapted from the Contributor Covenant.

  • Package manager: Yarn 1.22.19.

  • Automatic testing: Jest.

  • TypeScript 4.9.5 for built-in type definitions and support for compiling to ES3.

  • ESLint and Prettier.

  • Security policy and contribution guidelines.

  • Self-made scripts for verification of package.json and creation of an ESM wrapper around TypeScript's CommonJS output to allow for usage within both CJS and ESM projects.

Your todos as a user of this template

  • Change all placeholders all over different files.
  • Fill this README template.

npm-library-template's People

Contributors

dependabot[bot] avatar santi100a avatar

Watchers

 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.