Giving the experimental nature of this repo is recommended to don't install it using npm becuase it's possible that you run with an outdated version.
git clone https://github.com/edravis/pulse.git
cd pulse
npm install
npm test
In order to bring to life this Pulse you need:
- nodejs ^4.2.1
- a Twitter app account
If you don't have any Twitter app you can create one at the apps dashboard. When you have the app created you have to create a file called auth.json placed at the root of the project. I've already added a default file for you. So, you can duplicate auth_default.json to auth.json and fill up the document. By the way, you may are interested to know that the .gitignore covers the auth.json file ;)
I'm currently using this repo as lab for experiment with the meta configuration of the Javascript's projects: testing, coding standard, code coverage, continous integration, etc. If you think something is messed up or you want to add something feel free to comment, ask, PR, or whatever. However, in order to make it easy, here's my little roadmap:
- Unit testing
- Automatic documentation
- Code coverage
- Badgifier
- Coding standard
- Continous integration
- Commitizen
- Pre-commit hooks
- Automatic changelog
- Semver
- Automatic generate reports for releases
Using documentation.js it generated automatic documentation. You'll find it on the docs folder at the project's root. The generated output is a simply .html so run it with whatever you use to work. I really like http-server.
After the tests the project also generates the automatic code coverage thanks to instabul. You can access to the results on coverage/lcov-report placed at root. It's a simply .html directory.
With all the love from Rubén Sospedra