{"id":13681437,"url":"https://github.com/jsynowiec/node-flowtype-boilerplate","last_synced_at":"2025-04-30T03:31:23.602Z","repository":{"id":141754251,"uuid":"71513806","full_name":"jsynowiec/node-flowtype-boilerplate","owner":"jsynowiec","description":"This boilerplate repository is outdated and no longer maintained. Instead, I strongly recommend to use TypeScript.","archived":true,"fork":false,"pushed_at":"2018-11-01T13:50:58.000Z","size":239,"stargazers_count":103,"open_issues_count":0,"forks_count":20,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-12T00:36:42.137Z","etag":null,"topics":["boilerplate","es6","eslint","flow","flowtype","javascript","jest","nodejs","project-template","starter-template"],"latest_commit_sha":null,"homepage":"","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/jsynowiec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-10-20T23:57:19.000Z","updated_at":"2023-01-28T19:45:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"613ce3be-e415-4353-a52f-ee2ff7efb4af","html_url":"https://github.com/jsynowiec/node-flowtype-boilerplate","commit_stats":{"total_commits":79,"total_committers":4,"mean_commits":19.75,"dds":"0.44303797468354433","last_synced_commit":"c6ff964420a7dedccedca662a8fdff23b9fd4dbe"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsynowiec%2Fnode-flowtype-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsynowiec%2Fnode-flowtype-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsynowiec%2Fnode-flowtype-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsynowiec%2Fnode-flowtype-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsynowiec","download_url":"https://codeload.github.com/jsynowiec/node-flowtype-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251635233,"owners_count":21619178,"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":["boilerplate","es6","eslint","flow","flowtype","javascript","jest","nodejs","project-template","starter-template"],"created_at":"2024-08-02T13:01:30.714Z","updated_at":"2025-04-30T03:31:23.281Z","avatar_url":"https://github.com/jsynowiec.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![Dev dependencies][dependencies-badge]][dependencies]\n[![Node.js version][nodejs-badge]][nodejs]\n[![Yarn][yarn-badge]][yarn]\n[![Build Status][travis-badge]][travis-ci]\n\n[![MIT License][license-badge]][LICENSE]\n[![PRs Welcome][prs-badge]][prs]\n[![Donate][donate-badge]][donate]\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n[![Tweet][twitter-badge]][twitter]\n\n# node-flowtype-boilerplate\n\nNotice: This boilerplate repository is outdated and no longer maintained. I do not use Flowtype anymore in my projects.\n\nInstead, I strongly recommend to use TypeScript. You can try my [Node.js TypeScript boilerplate](https://github.com/jsynowiec/node-typescript-boilerplate) repository.\n\n---\n\nMinimalistic boilerplate to jump-start a [Node.js][nodejs] project in ES6 with [Flow][flowtype] type checking.\n\nProvides a basic template, batteries included:\n\n+ ES6 + babel,\n  + Removes Flow type annotations,\n  + Transforms imports to lazy CommonJS requires,\n  + Transforms async/await to generators,\n+ [ESLint][eslint] with the [airbnb-base][airbnb-base] and [flowtype][eslint-flowtype] rules,\n+ [Jest][jest] unit testing and coverage,\n+ [Type definitions][flow-typed] for Jest,\n+ [NPM scripts for common operations](#available-scripts),\n+ [.editorconfig][editorconfig] for consistent file format,\n\n## Quick start\n\nThis project requires [Node.js][nodejs] v8.9 (LTS Carbon) or later and [Yarn][yarn]. Make sure you have those installed. Then just type following commands:\n\n```\ngit clone https://github.com/jsynowiec/node-flowtype-boilerplate\ncd node-flowtype-boilerplate\nyarn\n```\n\n## Available scripts\n\nRun using `yarn run \u003cscript\u003e` comand.\n\n+ `clean` - remove coverage data, Jest cache and transpiled files,\n+ `lint` - lint source files and tests,\n+ `typecheck` - check type annotations,\n+ `test` - lint, typecheck and run tests with coverage,\n+ `test-only` - run tests with coverage,\n+ `test:watch` - interactive watch mode to automatically re-run tests, \n+ `build` - compile source files,\n+ `build:watch` - interactive watch mode, compile sources on change.\n\n## Questions\n\nIf you have any questions regarding this project:\n\n* consult the [FAQ][wiki-faq] wiki page first,\n* search for [issues marked as *question*][issues-question],\n* if none of the above is appropriate, [open an issue][new-issue].\n\n## Alternative\n\nAs an alternative to Flow type checking, you can try my [Node.js TypeScript boilerplate][ts-boilerplate]. It's basically the same but with TypeScript and TSLint.\n\n## License\nReleased under MIT license. See the [LICENSE](https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/LICENSE) file.\n\n[dependencies-badge]: https://david-dm.org/jsynowiec/node-flowtype-boilerplate/dev-status.svg\n[dependencies]: https://david-dm.org/jsynowiec/node-flowtype-boilerplate?type=dev\n[nodejs-badge]: https://img.shields.io/badge/node-\u003e=%208.9-blue.svg\n[nodejs]: https://nodejs.org/dist/latest-v8.x/docs/api/\n[yarn-badge]: https://img.shields.io/badge/yarn-\u003e=%201.0-blue.svg\n[yarn]: https://yarnpkg.com\n[travis-badge]: https://travis-ci.org/jsynowiec/node-flowtype-boilerplate.svg?branch=master\n[travis-ci]: https://travis-ci.org/jsynowiec/node-flowtype-boilerplate\n[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg\n[license]: https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[prs]: http://makeapullrequest.com\n[donate-badge]: https://img.shields.io/badge/$-support-green.svg\n[donate]: http://bit.ly/donate-js\n[github-watch-badge]: https://img.shields.io/github/watchers/jsynowiec/node-flowtype-boilerplate.svg?style=social\n[github-watch]: https://github.com/jsynowiec/node-flowtype-boilerplate/watchers\n[github-star-badge]: https://img.shields.io/github/stars/jsynowiec/node-flowtype-boilerplate.svg?style=social\n[github-star]: https://github.com/jsynowiec/node-flowtype-boilerplate/stargazers\n[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20this%20Node.js%20ES6+%20@flowtype%20boilerplate%20https://github.com/jsynowiec/node-flowtype-boilerplate%20%F0%9F%91%8D\n[twitter-badge]: https://img.shields.io/twitter/url/https/jsynowiec/node-flowtype-boilerplate.svg?style=social\n[jest]: https://facebook.github.io/jest/\n\n[flowtype]: https://flowtype.org/\n[eslint]: http://eslint.org/\n[airbnb-base]: https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base\n[eslint-flowtype]: https://www.npmjs.com/package/eslint-plugin-flowtype\n[flow-typed]: https://github.com/flowtype/flow-typed\n[editorconfig]: https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/.editorconfig\n\n[ts-boilerplate]: https://github.com/jsynowiec/node-typescript-boilerplate\n\n[wiki-faq]: https://github.com/jsynowiec/node-flowtype-boilerplate/wiki/FAQ\n\n[new-issue]: https://github.com/jsynowiec/node-flowtype-boilerplate/issues/new\n[issues-question]: https://github.com/jsynowiec/node-flowtype-boilerplate/issues?utf8=✓\u0026q=label%3Aquestion%20\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsynowiec%2Fnode-flowtype-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsynowiec%2Fnode-flowtype-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsynowiec%2Fnode-flowtype-boilerplate/lists"}