{"id":27302391,"url":"https://github.com/steinathan/waterdom","last_synced_at":"2025-04-12T02:38:51.845Z","repository":{"id":143990264,"uuid":"193798635","full_name":"steinathan/waterdom","owner":"steinathan","description":"This description will be filled later","archived":false,"fork":false,"pushed_at":"2023-10-19T21:58:43.000Z","size":435,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-12T02:38:45.381Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steinathan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-06-25T23:51:09.000Z","updated_at":"2019-06-25T23:55:11.000Z","dependencies_parsed_at":"2024-06-12T09:07:54.352Z","dependency_job_id":null,"html_url":"https://github.com/steinathan/waterdom","commit_stats":null,"previous_names":["steinathan/waterdom"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steinathan%2Fwaterdom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steinathan%2Fwaterdom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steinathan%2Fwaterdom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steinathan%2Fwaterdom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steinathan","download_url":"https://codeload.github.com/steinathan/waterdom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248507192,"owners_count":21115554,"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":"2025-04-12T02:38:51.127Z","updated_at":"2025-04-12T02:38:51.828Z","avatar_url":"https://github.com/steinathan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📚 waterdom\n\n\u003e Full featured boilerplate for building JavaScript libraries the modern way.\n\n## Features\n\n- 📜 [Rollup.js](https://rollupjs.org/guide/en) configuration providing compatibility with different module systems (CommonJS, ECMAScript, UMD for `\u003cscript\u003e` tags)\n- 🃏 [Jest](http://jestjs.io/) setup with watch mode working\n- 🛀 [Renovate](https://github.com/apps/renovate) configuration for auto updates (you have to activate it via https://github.com/apps/renovate)\n- 🐈 [Yarn](https://yarnpkg.com/) with lock file, [pinned](https://renovatebot.com/docs/dependency-pinning/) devDependencies and fixed Yarn version in .yarnrc using [Yarn policies](https://yarnpkg.com/lang/en/docs/cli/policies/)\n- ✅ [Travis CI](https://travis-ci.com/)\n- 🏗 [.nvmrc](https://github.com/creationix/nvm) file to enforce the Node.js version for contributors and continuous integration\n- ⚡️ Ready to publish and use\n\n## How to use\n\nDecide of a new library name, let's say `new-super-library` (🤦🏼‍♀️), then in a terminal:\n\n```sh\ncurl --output waterdom.zip -LOk https://github.com/algolia/waterdom/archive/master.zip\nunzip waterdom.zip\nrm waterdom.zip\nmv waterdom-master new-super-library\n```\n\n**Next steps:**\n\n- search the project for `rollup-starter-lib` and replace everywhere with `new-super-library`\n- start coding in [src/main.js](src/main.js)\n- profit 💸\n\n## Live examples\n\nThose examples are using the live published version of this boilerplate library on [npm](https://www.npmjs.com/waterdom) and they run with [CodeSandbox](https://codesandbox.io/).\n\n- [ECMAScript](https://codesandbox.io/s/7ojknnqjl6?module=%2Fsrc%2Findex.js)\n- [CommonJS](https://codesandbox.io/s/o5q018q609?module=%2Fsrc%2Findex.js)\n- [UMD](https://codesandbox.io/s/jyqqp21rv), this leverages [jsDelivr npm CDN](https://www.jsdelivr.com/features)\n\n## Developer environment requirements\n\nTo run this project, you will need:\n\n- Node.js \u003e= v10.5.0, use nvm - [install instructions](https://github.com/creationix/nvm#install-script)\n- Yarn \u003e= v1.7.0 - [install instructions (\"Alternatives\" tab)](https://yarnpkg.com/en/docs/install#alternatives-rc)\n\n## Running tests\n\n```sh\nyarn\nyarn test\nyarn test --watch\n```\n\n## Dev mode\n\nWhen developing you can run:\n\n```\nyarn watch\n```\n\nThis will regenerate the build files each time a source file is changed and serve on http://127.0.0.1:5000.\n\n### Previewing umd build in the browser\n\nIf your package works in the browser, you can open `dev/index.html` to try it out.\n\n## Publishing\n\n```sh\nnpm publish\n```\n\n## Additional tooling\n\nBased on your need, you might want to add:\n\n- [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)\n- [TypeScript](https://www.typescriptlang.org/) support\n- Monorepo support with [Lerna](https://lernajs.io/)\n- CHANGELOG.md generation with [conventional-changelog](https://github.com/conventional-changelog)\n\nIf so, please do and open pull requests when you feel like it.\n\n## Original idea\n\nI initially used [rollup/rollup-starter-lib](https://github.com/rollup/rollup-starter-lib) but really needed that Jest support so I did it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteinathan%2Fwaterdom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteinathan%2Fwaterdom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteinathan%2Fwaterdom/lists"}