https://github.com/edtoken/clean-js-pkg
Tiny Javascript package to help to configure the javascript package to deploy on the npm with travis
https://github.com/edtoken/clean-js-pkg
javascript npm npm-package publish-npm publish-npm-package travis-ci travis-ci-configuration travis-config
Last synced: 3 months ago
JSON representation
Tiny Javascript package to help to configure the javascript package to deploy on the npm with travis
- Host: GitHub
- URL: https://github.com/edtoken/clean-js-pkg
- Owner: edtoken
- License: mit
- Created: 2019-05-26T11:23:56.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:41:39.000Z (over 3 years ago)
- Last Synced: 2025-01-02T17:33:07.718Z (5 months ago)
- Topics: javascript, npm, npm-package, publish-npm, publish-npm-package, travis-ci, travis-ci-configuration, travis-config
- Language: JavaScript
- Homepage: http://edtoken.github.io/build-and-publish-npm
- Size: 79.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# How to publish the javascript package on the npm with travis
[](https://www.npmjs.com/package/@edtoken/clean-js-pkg) [](https://travis-ci.org/edtoken/clean-js-pkg) [](https://codeclimate.com/github/edtoken/clean-js-pkg/maintainability)
> Tiny Javascript package to help to configure the javascript package
> to deploy on the npm with travis
See [CodeSandbox usage](CODESANDBOX LINK)
## Features
- tests
- travis deploy
- dotenv
## Usage
##### 1. Copy the package
Clone the repo
```
git clone git clone [email protected]:edtoken/clean-js-pkg.git
```
Please! Do not add the .env file to the GIT, it's local file, for local development/common builds
##### 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 SECURE_KEY value.
To able, to deploy the npm package from the `travis`
you should add the environment variable `SECURE_KEY` in the travis UI.
##### 5. Publish
## Other examples
See the Main article [Build and publish your NPM package](https://github.com/edtoken/build-and-publish-npm)
- [Clean JS](https://github.com/edtoken/clean-js-pkg) [](https://www.npmjs.com/package/@edtoken/clean-js-pkg) [](https://travis-ci.org/edtoken/clean-js-pkg) [](https://codeclimate.com/github/edtoken/clean-js-pkg/maintainability) [](https://github.com/edtoken/clean-js-pkg)
- [Clean JS + Parcel](https://github.com/edtoken/clean-js-parcel-pkg) [](https://www.npmjs.com/package/@edtoken/clean-js-parcel-pkg) [](https://travis-ci.org/edtoken/clean-js-parcel-pkg) [](https://codeclimate.com/github/edtoken/clean-js-parcel-pkg/maintainability) [](https://github.com/edtoken/clean-js-parcel-pkg)
- [Clean JS + Webpack](https://github.com/edtoken/clean-js-webpack-pkg) [](https://www.npmjs.com/package/@edtoken/clean-js-webpack-pkg) [](https://travis-ci.org/edtoken/clean-js-webpack-pkg) [](https://codeclimate.com/github/edtoken/clean-js-webpack-pkg/maintainability) [](https://github.com/edtoken/clean-js-webpack-pkg)
- [Clean TypeScript](https://github.com/edtoken/clean-typescript-pkg) [](https://www.npmjs.com/package/@edtoken/clean-typescript-pkg) [](https://travis-ci.org/edtoken/clean-typescript-pkg) [](https://codeclimate.com/github/edtoken/clean-typescript-pkg/maintainability) [](https://github.com/edtoken/clean-typescript-pkg)
- [Clean Vue](https://github.com/edtoken/clean-vue-pkg) [](https://www.npmjs.com/package/@edtoken/clean-vue-pkg) [](https://travis-ci.org/edtoken/clean-vue-pkg) [](https://codeclimate.com/github/edtoken/clean-vue-pkg/maintainability) [](https://github.com/edtoken/clean-vue-pkg)
- [Clean React](https://github.com/edtoken/clean-react-pkg) [](https://www.npmjs.com/package/@edtoken/clean-react-pkg) [](https://travis-ci.org/edtoken/clean-react-pkg) [](https://codeclimate.com/github/edtoken/clean-react-pkg/maintainability) [](https://github.com/edtoken/clean-react-pkg)
- [Vue + vue-cli](https://github.com/edtoken/clean-vue-cli-pkg) [](https://www.npmjs.com/package/@edtoken/clean-vue-cli-pkg) [](https://travis-ci.org/edtoken/clean-vue-cli-pkg) [](https://codeclimate.com/github/edtoken/clean-vue-cli-pkg/maintainability) [](https://github.com/edtoken/clean-vue-cli-pkg)
- [Vue + TypeScript](https://github.com/edtoken/clean-vue-typescript-pkg) [](https://www.npmjs.com/package/@edtoken/clean-vue-typescript-pkg) [](https://travis-ci.org/edtoken/clean-vue-typescript-pkg) [](https://codeclimate.com/github/edtoken/clean-vue-typescript-pkg/maintainability) [](https://github.com/edtoken/clean-vue-typescript-pkg)
- [React + create-react-app](https://github.com/edtoken/clean-react-cra-pkg) [](https://www.npmjs.com/package/@edtoken/clean-react-cra-pkg) [](https://travis-ci.org/edtoken/clean-react-cra-pkg) [](https://codeclimate.com/github/edtoken/clean-react-cra-pkg/maintainability) [](https://github.com/edtoken/clean-react-cra-pkg)
- [React + TypeScript](https://github.com/edtoken/clean-react-typescript-pkg) [](https://www.npmjs.com/package/@edtoken/clean-react-typescript-pkg) [](https://travis-ci.org/edtoken/clean-react-typescript-pkg) [](https://codeclimate.com/github/edtoken/clean-react-typescript-pkg/maintainability) [](https://github.com/edtoken/clean-react-typescript-pkg)