Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jsynowiec/node-flowtype-boilerplate

This boilerplate repository is outdated and no longer maintained. Instead, I strongly recommend to use TypeScript.
https://github.com/jsynowiec/node-flowtype-boilerplate

boilerplate es6 eslint flow flowtype javascript jest nodejs project-template starter-template

Last synced: 2 months ago
JSON representation

This boilerplate repository is outdated and no longer maintained. Instead, I strongly recommend to use TypeScript.

Awesome Lists containing this project

README 

        
[![Dev dependencies][dependencies-badge]][dependencies]

[![Node.js version][nodejs-badge]][nodejs]

[![Yarn][yarn-badge]][yarn]

[![Build Status][travis-badge]][travis-ci]



[![MIT License][license-badge]][LICENSE]

[![PRs Welcome][prs-badge]][prs]

[![Donate][donate-badge]][donate]



[![Watch on GitHub][github-watch-badge]][github-watch]

[![Star on GitHub][github-star-badge]][github-star]

[![Tweet][twitter-badge]][twitter]



# node-flowtype-boilerplate



Notice: This boilerplate repository is outdated and no longer maintained. I do not use Flowtype anymore in my projects.



Instead, I strongly recommend to use TypeScript. You can try my [Node.js TypeScript boilerplate](https://github.com/jsynowiec/node-typescript-boilerplate) repository.



---



Minimalistic boilerplate to jump-start a [Node.js][nodejs] project in ES6 with [Flow][flowtype] type checking.



Provides a basic template, batteries included:



+ ES6 + babel,

  + Removes Flow type annotations,

  + Transforms imports to lazy CommonJS requires,

  + Transforms async/await to generators,

+ [ESLint][eslint] with the [airbnb-base][airbnb-base] and [flowtype][eslint-flowtype] rules,

+ [Jest][jest] unit testing and coverage,

+ [Type definitions][flow-typed] for Jest,

+ [NPM scripts for common operations](#available-scripts),

+ [.editorconfig][editorconfig] for consistent file format,



## Quick start



This 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:



```

git clone https://github.com/jsynowiec/node-flowtype-boilerplate

cd node-flowtype-boilerplate

yarn

```



## Available scripts



Run using `yarn run ` comand.



+ `clean` - remove coverage data, Jest cache and transpiled files,

+ `lint` - lint source files and tests,

+ `typecheck` - check type annotations,

+ `test` - lint, typecheck and run tests with coverage,

+ `test-only` - run tests with coverage,

+ `test:watch` - interactive watch mode to automatically re-run tests, 

+ `build` - compile source files,

+ `build:watch` - interactive watch mode, compile sources on change.



## Questions



If you have any questions regarding this project:



* consult the [FAQ][wiki-faq] wiki page first,

* search for [issues marked as *question*][issues-question],

* if none of the above is appropriate, [open an issue][new-issue].



## Alternative



As 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.



## License

Released under MIT license. See the [LICENSE](https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/LICENSE) file.



[dependencies-badge]: https://david-dm.org/jsynowiec/node-flowtype-boilerplate/dev-status.svg

[dependencies]: https://david-dm.org/jsynowiec/node-flowtype-boilerplate?type=dev

[nodejs-badge]: https://img.shields.io/badge/node->=%208.9-blue.svg

[nodejs]: https://nodejs.org/dist/latest-v8.x/docs/api/

[yarn-badge]: https://img.shields.io/badge/yarn->=%201.0-blue.svg

[yarn]: https://yarnpkg.com

[travis-badge]: https://travis-ci.org/jsynowiec/node-flowtype-boilerplate.svg?branch=master

[travis-ci]: https://travis-ci.org/jsynowiec/node-flowtype-boilerplate

[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg

[license]: https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/LICENSE

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[prs]: http://makeapullrequest.com

[donate-badge]: https://img.shields.io/badge/$-support-green.svg

[donate]: http://bit.ly/donate-js

[github-watch-badge]: https://img.shields.io/github/watchers/jsynowiec/node-flowtype-boilerplate.svg?style=social

[github-watch]: https://github.com/jsynowiec/node-flowtype-boilerplate/watchers

[github-star-badge]: https://img.shields.io/github/stars/jsynowiec/node-flowtype-boilerplate.svg?style=social

[github-star]: https://github.com/jsynowiec/node-flowtype-boilerplate/stargazers

[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

[twitter-badge]: https://img.shields.io/twitter/url/https/jsynowiec/node-flowtype-boilerplate.svg?style=social

[jest]: https://facebook.github.io/jest/



[flowtype]: https://flowtype.org/

[eslint]: http://eslint.org/

[airbnb-base]: https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base

[eslint-flowtype]: https://www.npmjs.com/package/eslint-plugin-flowtype

[flow-typed]: https://github.com/flowtype/flow-typed

[editorconfig]: https://github.com/jsynowiec/node-flowtype-boilerplate/blob/master/.editorconfig



[ts-boilerplate]: https://github.com/jsynowiec/node-typescript-boilerplate



[wiki-faq]: https://github.com/jsynowiec/node-flowtype-boilerplate/wiki/FAQ



[new-issue]: https://github.com/jsynowiec/node-flowtype-boilerplate/issues/new

[issues-question]: https://github.com/jsynowiec/node-flowtype-boilerplate/issues?utf8=✓&q=label%3Aquestion%20