Katatonic
Simple website generator to navigate git repositories.
Installation
npm install katatonic
Usage
From your git repository folder
$ node katatonic
It will open our default browser to let you navigate your code
Unit tests and integration tests
You need to run node and then run the tests suite
node index.js
npm test
In the current example the unit tests are located in the file test/test_libraries.js, and also the example function in the file example_unittest.js, and the integration tests are located in the file test/test-dynamic_routes.jsoutes.js
Test coverage
https://coveralls.io/github/franferri/katatonic
CI
https://travis-ci.org/franferri/katatonic
NPM
https://www.npmjs.com/package/katatonic
To release a new version we have to use: npm version UPDATE_TYPE -m "DESCRIPTION", where update_type is one of the semantic (https://semver.org/) versioning release types: patch, minor, or major.
npm version patch -m "EXAMPLE"
NPM full example
- Changes to the code
- git add .
- git commit -m "EXAMPLE"
- npm version patch -m "EXAMPLE"
- git push origin master
- npm publish
Contributing
Please feel free to contribute, we are always open to new ideas or improvements. At this point we dont have any contributing guidelines, we are just creating the MVP.