Twitter Stream API Client

A Twitter Stream API implementation.

Usage

Comming soon.

NPM scripts

• yarn t: Run test suite
• yarn start: Run npm run build in watch mode
• yarn test:watch: Run test suite in interactive watch mode
• yarn test:prod: Run linting and generate coverage
• yarn build: Generate bundles and typings, create docs
• yarn lint: Lints code
• yarn commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Automatic releases

Prerequisites: you need to create/login accounts and add your project to:

• npm
• Travis CI
• Coveralls

Setup steps

From now on, you'll need to use yarn commit, which is a convenient way to create conventional commits.

Automatic releases are possible thanks to semantic release, which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by Kent C. Dodds course on egghead.io

Git Hooks

There is already set a precommit hook for formatting your code with Prettier :nail_care:

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

• You follow a conventional commit message
• Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push

This makes more sense in combination with automatic releases