Code Monkey home page Code Monkey logo

build-and-publish-npm's Introduction

Build and publish your NPM package

stars

Short example How to Build and Publish your NPM package

Table of Contents

Motivation

Sometimes, you need to make some npm packages.

And, in some cases it could be a little bit difficult, to understand how to setup it.
How to setup the Travis test, build, deploy.
Which files should be in the files section in the package.json and etc.

That tiny packages will help you to understand how it works.
You able to clone it and setup as you need and it will work.

The packages very small.
It means that they do not include some things, it could be some tests, configs, etc.
The Philosophy is - this is very small clean packages to basic setup your package.

Supported Features

The supported features in the packages.

  • Travis config
  • Eslint config
  • unit/e2e tests

Implemented Packages

The repositories with package examples.
Please clone it and configure as you need.

Publish my own package step by step

The package repos are ready packages for usage.
So, you can just copy any of them. See Packages.

1. Copy the package

Copy any of the Implemented packages from a repo.

git clone [email protected]:edtoken/clean-react-typescript-pkg.git 
2. Update travis configuration

Update the .travis.yml file, replace the email and repo

3. Update package.json

Update name, description, repository, author, and licenses

4. Update travis environment, Add NPM_TOKEN value.

To able, to deploy the npm package from the travis
you should update the travis environment.
Please add NPM_TOKEN key.

build-and-publish-npm's People

Contributors

edtoken avatar

Watchers

 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.