FICK
Fucking Incredible Command line King. Add CLI flavour to any website you like to.
FICK is highly under development and is for now only available for www.wg-gesucht.de. Checkout the roadmap and feel free to contribute.
Pre-requirements
You will need node
and yarn
installed already on your machine. Further reading for installing node.js and yarn click here:
Both are required to use FICK
. node.js is the so to speak paradigma for server-side JavaScript (JS) implementation. yarn is the better node package manger (npm) for dependency management.
Installation
[sudo] yarn global add fick # use sudo only, if you recieve a permission error
You can also use npm for installation, if yarn is not installed yet:
[sudo] npm install -g fick # use sudo only, if you recieve a permission error
Usage
fick [Stuttgart|Ludwigsburg|Esslingen] # parameters are contingent
Screenshot
There will be an output of (for now) maximum 5 lines of information. At the bottom there is an menu for refreshing the results or changing the target city for crawling information.
Contribution
Fork that repository, install dependencies with yarn or npm and use the following commands to test functionality:
yarn test # run jest test suite and watch file change yarn start # run FICK main module
Please stick to semver versioning. Add an issue and add a merge request on GitHub.
Licence
Yeah, it is GPL v2. Feel free to use that piece to code!
Author
I am Michael Czechowski (www.dailysh.it) web developer from Stuttgart in the deep southern part of Germany. Do not hesitate to contact me: mail@dailysh.it