https://github.com/brikcss/starter-module
Starter project for creating JS / Node modules.
https://github.com/brikcss/starter-module
Last synced: 12 months ago
JSON representation
Starter project for creating JS / Node modules.
- Host: GitHub
- URL: https://github.com/brikcss/starter-module
- Owner: brikcss
- License: mit
- Created: 2018-03-22T03:23:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-03T15:29:17.000Z (about 7 years ago)
- Last Synced: 2025-02-14T17:16:14.631Z (over 1 year ago)
- Language: JavaScript
- Size: 421 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Starter Module
Starter project for a JS/CSS Node/Browser module.
About •
Environment and browser support •
Install •
Quick Start •
Configuration •
API •
Credits •
License
⚠️ IMPORTANT: Brikcss follows semantic versioning. This package is currently at major version zero, which means "anything may change at any time", and it "should not be considered stable".
## About ❓
Starter project for a JS / Node module.
## Contributing ❤️
We ❤️❤️❤️ contributions of any kind! Whether it's bug reports, questions or feature requests, pull requests, and especially spreading some love about this project to your friends and co-workers!
**[Read our contributing guidelines](./CONTRIBUTING.md) and get involved to support this project.
_Or give us a ⭐ on GitHub!_**
## Environment and browser support ☘️
| Node | CLI | Browser | UMD | ES Module |
| :--: | :-: | :-----: | :-: | :-------: |
| ✅ | ❌ | ✅ | ✅ | ✅ |
| Chrome | Firefox | Safari | Edge | IE | iOS | Android |
| :----: | :-----: | :----: | :--: | :-: | :-: | :-----: |
| ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ |
## Install 📦
### NPM
```bash
npm install -D @brikcss/starter-module
```
### GitHub
Download the [latest release](https://github.com/brikcss/starter-module/releases/latest).
_Note: If you install from GitHub, remove `node_modules/@brikcss/starter-module` from any documented file paths._
## Quick Start 🏁
Get up and running in less than five minutes:
1. Install:
```bash
git clone git@github.com:brikcss/starter-module.git
cd && rm -rf .git && git init
git remote add origin
```
2. Modify/remove project files according to needs.
- Install `semantic-release` when ready (not installed by default due to security issues).
- Install shots/puppeteer when ready (not installed by default due to security issues).
3. Configure Travis build environment:
- `NPM_TOKEN` -> NPM token.
- `GITHUB_TOKEN` -> GitHub token.
- `CODACY_PROJECT_TOKEN` -> Codacy project API token.
- `COVERALLS_REPO_TOKEN` -> Coveralls token.
## Configuration ⚙️
### `propertyName`
> Type: **`string`** **(required)** Default: `default` Options: `'one'`, `'two'`
Documentation goes here.
## API 🤖
### `Method()`
> - **`arg1`** \{String\} _['default']_ _(required)_ Property description.
> - **`arg2`** \{String\} _['prop']_ Property description.
## Credits 🙏
- Credit goes to...
## License 📃
[See License](LICENSE.md).