Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tasoskakour/boiler-js

🥗 A boiler-js structure that helps with building npm modules
https://github.com/tasoskakour/boiler-js

Last synced: about 1 month ago
JSON representation

🥗 A boiler-js structure that helps with building npm modules

Host: GitHub
URL: https://github.com/tasoskakour/boiler-js
Owner: tasoskakour
Created: 2019-09-28T17:57:20.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-01-04T11:38:18.000Z (almost 2 years ago)
Last Synced: 2024-04-26T02:21:18.221Z (8 months ago)
Language: JavaScript
Size: 461 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# boiler-js

> 🥗 A boiler-js structure that helps with building and publishing npm modules.

## Development :computer:
```bash
$ git clone [email protected]:tasoskakour/boiler-js.git
$ cd boiler-js
$ yarn install
```

## Install :hammer:
```bash
$ yarn install your-module-name
```

## Usage
```javascript
// Placeholder - Write your own quick example
```

## Testing :bomb:
```bash
$ yarn test # add -- --watch to monitor for changes
```

## Deploy :ship:
This app will automatically get published under `your-module-name` on npm (when new code is on master and a new tag exists with `vX.X.X` format)

:rotating_light: **Check the [config.yml](./.circleci/config.yml) for more**

Here is an example:

```bash
git checkout master
# Will generate a tag as well
npm version patch #or major, minor, patch

git push --follow-tags
```