https://github.com/nextlevelshit/fick
Fucking Incredible Command line King. Add CLI flavour to any website you like to.
https://github.com/nextlevelshit/fick
cli crawler
Last synced: 4 months ago
JSON representation
Fucking Incredible Command line King. Add CLI flavour to any website you like to.
- Host: GitHub
- URL: https://github.com/nextlevelshit/fick
- Owner: nextlevelshit
- License: gpl-2.0
- Created: 2017-06-22T13:37:31.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-29T10:33:29.000Z (almost 9 years ago)
- Last Synced: 2025-10-06T11:39:58.485Z (9 months ago)
- Topics: cli, crawler
- Language: HTML
- Homepage: http://www.dailysh.it
- Size: 80.1 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
- [Install *node.js* on Ubuntu](https://wiki.ubuntuusers.de/Node.js/)
- [Install *node.js* on any other operating system (OS)](https://nodejs.org/en/download/package-manager/)
- [Install *yarn* on any OS](https://yarnpkg.com/lang/en/docs/install/)
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
```bash
[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:
```bash
[sudo] npm install -g fick # use sudo only, if you recieve a permission error
```
## Usage
```bash
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:
```bash
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](http://www.dailysh.it)) web developer from Stuttgart in the deep southern part of Germany. Do not hesitate to contact me: mail@dailysh.it