{"id":18254259,"url":"https://github.com/brikcss/starter-module","last_synced_at":"2025-06-29T17:37:01.687Z","repository":{"id":143742061,"uuid":"126273911","full_name":"brikcss/starter-module","owner":"brikcss","description":"Starter project for creating JS / Node modules.","archived":false,"fork":false,"pushed_at":"2019-06-03T15:29:17.000Z","size":431,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T17:16:14.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brikcss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-22T03:23:04.000Z","updated_at":"2019-06-03T15:29:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"20b905d4-6ab5-4ab7-b87b-3363e86f0124","html_url":"https://github.com/brikcss/starter-module","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikcss%2Fstarter-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikcss%2Fstarter-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikcss%2Fstarter-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikcss%2Fstarter-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brikcss","download_url":"https://codeload.github.com/brikcss/starter-module/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247934808,"owners_count":21020724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T10:11:18.405Z","updated_at":"2025-04-08T21:47:23.437Z","avatar_url":"https://github.com/brikcss.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    Starter Module\n    \u003ca class=\"headerlink\" href=\"#starter-module\" title=\"Permanent link\"\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/brikcss\" title=\"Brikcss\"\u003e\n        \u003cimg src=\"./assets/logo-brikcss.png\" alt=\"Brikcss logo\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003eStarter project for a JS/CSS Node/Browser module.\u003c/h4\u003e\n\n\u003c!-- Table of Contents. --\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#about\"\u003eAbout\u003c/a\u003e •\n  \u003ca href=\"#environment-and-browser-support\"\u003eEnvironment and browser support\u003c/a\u003e •\n  \u003ca href=\"#install\"\u003eInstall\u003c/a\u003e •\n  \u003ca href=\"#quick-start\"\u003eQuick Start\u003c/a\u003e •\n  \u003ca href=\"#configuration\"\u003eConfiguration\u003c/a\u003e •\n  \u003ca href=\"#api\"\u003eAPI\u003c/a\u003e •\n  \u003ca href=\"#credits\"\u003eCredits\u003c/a\u003e •\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- Shields. --\u003e\n\u003cp align=\"center\"\u003e\n    \u003c!-- NPM version. --\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@brikcss/starter-module\"\u003e\n        \u003cimg alt=\"NPM version\" src=\"https://img.shields.io/npm/v/@brikcss/starter-module.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- NPM tag version. --\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@brikcss/starter-module\"\u003e\n        \u003cimg alt=\"NPM version\" src=\"https://img.shields.io/npm/v/@brikcss/starter-module/next.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- NPM downloads/month. --\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@brikcss/starter-module\"\u003e\n        \u003cimg alt=\"NPM downloads per month\" src=\"https://img.shields.io/npm/dm/@brikcss/starter-module.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Travis branch. --\u003e\n    \u003ca href=\"https://github.com/brikcss/starter-module/tree/master\"\u003e\n        \u003cimg alt=\"Travis branch\" src=\"https://img.shields.io/travis/rust-lang/rust/master.svg?style=for-the-badge\u0026label=master\"\u003e\n    \u003c/a\u003e\n    \u003c!-- GitHub issues. --\u003e\n    \u003ca href=\"https://github.com/brikcss/starter-module/issues\"\u003e\n        \u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/brikcss/starter-module.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Codacy. --\u003e\n    \u003c!-- \u003ca href=\"https://www.codacy.com\"\u003e\n        \u003cimg alt=\"Codacy code quality\" src=\"https://img.shields.io/codacy/grade/\u003center token here\u003e/master.svg?style=for-the-badge\"\u003e\n        \u003c/a\u003e --\u003e\n    \u003c!-- \u003ca href=\"https://www.codacy.com\"\u003e\n        \u003cimg alt=\"Codacy code coverage\" src=\"https://img.shields.io/codacy/coverage/\u003center token here\u003e/master.svg?style=for-the-badge\"\u003e\n        \u003c/a\u003e --\u003e\n    \u003c!-- Coveralls --\u003e\n    \u003c!-- \u003ca href='https://coveralls.io/github/brikcss/starter-module?branch=master'\u003e\n        \u003cimg src='https://img.shields.io/coveralls/github/brikcss/starter-module/master.svg?style=for-the-badge' alt='Coverage Status' /\u003e\n    \u003c/a\u003e --\u003e\n    \u003c!-- MIT License. --\u003e\n    \u003ca href=\"LICENSE.md\"\u003e\n        \u003cimg alt=\"License\" src=\"https://img.shields.io/npm/l/express.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- JS Standard style. --\u003e\n    \u003ca href=\"https://standardjs.com\"\u003e\n        \u003cimg alt=\"JavaScript Style Guide\" src=\"https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Prettier code style. --\u003e\n    \u003ca href=\"https://prettier.io/\"\u003e\n        \u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Semantic release. --\u003e\n    \u003c!-- \u003ca href=\"https://github.com/semantic-release/semantic-release\"\u003e\n        \u003cimg alt=\"semantic release\" src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e --\u003e\n    \u003c!-- Commitizen friendly. --\u003e\n    \u003ca href=\"http://commitizen.github.io/cz-cli/\"\u003e\n        \u003cimg alt=\"Commitizen friendly\" src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Greenkeeper. --\u003e\n    \u003ca href=\"https://greenkeeper.io/\"\u003e\n        \u003cimg src=\"https://badges.greenkeeper.io/brikcss/starter-module.svg?style=flat-square\" alt=\"Greenkeeper badge\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- [![NPM version][npm-version-img]][npm-url]\n[![NPM next][npm-next-img]][npm-url]\n[![NPM downloads per month][npm-downloads-img]][npm-url]\n[![Build status][build-img]][build-url]\n[![Codacy code quality][codacy-quality-img]][codacy-url]\n[![Codacy coverage][codacy-coverage-img]][codacy-url]\n[![Coveralls coverage][coveralls-img]][coveralls-url]\n[![We love StandardJS][standardjs-img]][standardjs-url]\n[![We love Prettier][prettier-img]][prettier-url]\n[![We love Semantic Release][semantic-img]][semantic-url]\n[![We love Commitizen][commitizen-img]][commitizen-url]\n[![We love Greenkeeper][greenkeeper-img]][greenkeeper-url]\n[![License][license-img]][license-url]\n\n[npm-url]: https://www.npmjs.com/package/@brikcss/starter-module\n[npm-version-img]: https://img.shields.io/npm/v/@brikcss/starter-module.svg?style=for-the-badge\n[npm-next-img]: https://img.shields.io/npm/v/@brikcss/starter-module.svg?style=for-the-badge\n[npm-downloads-img]: https://img.shields.io/npm/dm/@brikcss/starter-module.svg?style=for-the-badge\n[build-url]: https://github.com/brikcss/starter-module/tree/master\n[build-img]: https://img.shields.io/travis/rust-lang/rust/master.svg?style=for-the-badge\u0026label=master\n[codacy-url]: https://www.codacy.com\n[codacy-quality-img]: https://img.shields.io/codacy/grade/\u003center-token-here\u003e/master.svg?style=for-the-badge\n[codacy-coverage-img]: https://img.shields.io/codacy/coverage/\u003center-token-here\u003e/master.svg?style=for-the-badge\n[coveralls-url]: https://coveralls.io/github/brikcss/starter-module?branch=master\n[coveralls-img]: https://img.shields.io/coveralls/github/brikcss/starter-module/master.svg?style=for-the-badge\n[standardjs-url]: https://standardjs.com\n[standardjs-img]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=for-the-badge\n[prettier-url]: https://prettier.io\n[prettier-img]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[semantic-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge\n[commitizen-url]: http://commitizen.github.io/cz-cli\n[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge\n[greenkeeper-url]: https://greenkeeper.io\n[greenkeeper-img]: https://badges.greenkeeper.io/brikcss/starter-module.svg?style=for-the-badge\n[license-url]: ./LICENSE.md\n[license-img]: https://img.shields.io/npm/l/express.svg?style=for-the-badge --\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cstrong\u003e⚠️ IMPORTANT: Brikcss follows semantic versioning. This package is currently at major version zero, which means \u003ca href=\"https://semver.org/#spec-item-4\" target=\"_blank\"\u003e\"anything may change at any time\", and it \"should not be considered stable\"\u003c/a\u003e.\u003c/strong\u003e\n\u003c/p\u003e\n\n## About ❓\n\nStarter project for a JS / Node module.\n\n## Contributing ❤️\n\nWe ❤️❤️❤️ 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!\n\n**[Read our contributing guidelines](./CONTRIBUTING.md) and get involved to support this project. \u003cbr\u003e_Or give us a ⭐ on GitHub!_**\n\n## Environment and browser support ☘️\n\n| Node | CLI | Browser | UMD | ES Module |\n| :--: | :-: | :-----: | :-: | :-------: |\n|  ✅  | ❌  |   ✅    | ✅  |    ✅     |\n\n| Chrome | Firefox | Safari | Edge | IE  | iOS | Android |\n| :----: | :-----: | :----: | :--: | :-: | :-: | :-----: |\n|   ✅   |   ✅    |   ✅   |  ✅  | ❌  | ✅  |   ✅    |\n\n## Install 📦\n\n### NPM\n\n```bash\nnpm install -D @brikcss/starter-module\n```\n\n### GitHub\n\nDownload the [latest release](https://github.com/brikcss/starter-module/releases/latest).\n\n_Note: If you install from GitHub, remove `node_modules/@brikcss/starter-module` from any documented file paths._\n\n## Quick Start 🏁\n\nGet up and running in less than five minutes:\n\n1.  Install:\n\n    ```bash\n    git clone git@github.com:brikcss/starter-module.git \u003cdirectory\u003e\n    cd \u003cdirectory\u003e \u0026\u0026 rm -rf .git \u0026\u0026 git init\n    git remote add origin \u003crepo url\u003e\n    ```\n\n2.  Modify/remove project files according to needs.\n\n    -   Install `semantic-release` when ready (not installed by default due to security issues).\n    -   Install shots/puppeteer when ready (not installed by default due to security issues).\n\n3.  Configure Travis build environment:\n\n    -   `NPM_TOKEN` -\u003e NPM token.\n    -   `GITHUB_TOKEN` -\u003e GitHub token.\n    -   `CODACY_PROJECT_TOKEN` -\u003e Codacy project API token.\n    -   `COVERALLS_REPO_TOKEN` -\u003e Coveralls token.\n\n## Configuration ⚙️\n\n### `propertyName`\n\n\u003e Type: **`string`** **(required)** Default: `default` Options: `'one'`, `'two'`\n\nDocumentation goes here.\n\n## API 🤖\n\n### `Method()`\n\n\u003e -   **`arg1`** \\{String\\} _['default']_ _(required)_ Property description.\n\u003e -   **`arg2`** \\{String\\} _['prop']_ Property description.\n\n## Credits 🙏\n\n-   Credit goes to...\n\n## License 📃\n\n[See License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrikcss%2Fstarter-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrikcss%2Fstarter-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrikcss%2Fstarter-module/lists"}