External/fredy
1
0
Fork 0
mirror of https://github.com/orangecoding/fredy.git synced 2026-06-16 12:31:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding a sentence about immoscout

Browse Source
This commit is contained in:
orangecoding
2021-01-22 13:17:34 +01:00
parent 4180f700b5
commit a3a648928f
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,13 +1,13 @@
<img src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400"> <img src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400">
[![Build Status](https://travis-ci.org/orangecoding/fredy.svg?branch=master)](https://travis-ci.org/orangecoding/fredy) [![Build Status](https://travis-ci.org/orangecoding/fredy.svg?branch=master)](https://travis-ci.org/orangecoding/fredy)
_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) as often as you want and send new listings to you once they appear. The list of available services can easily be extended. For your convenience, a ui helps you to configure your search jobs. _Fredy_ scrapes multiple services (Immonet, Immowelt etc.) as often as you want and send new listings to you once they appear. The list of available services can easily be extended. For your convenience, a ui helps you to configure your search jobs.
If _Fredy_ found matching results, it will send them to you via Slack, Email, Telegram etc. (More adapter possible.) As _Fredy_ will store the listings it found, new results will not be sent twice (and as a side-effect, _Fredy_ can show some statistics..) If _Fredy_ found matching results, it will send them to you via Slack, Email, Telegram etc. (More adapter possible.) As _Fredy_ will store the listings it found, new results will not be sent twice (and as a side-effect, _Fredy_ can show some statistics..)
## Usage ## Usage
- Make sure to use NodeJs 12 and above - Make sure to use NodeJs 12 and above
- Run the following commands - Run the following commands
```ssh ```ssh
@@ -49,7 +49,7 @@ yarn run dev
You should now be able to access _Fredy_ with your browser. Go to `http://localhost:9000` You should now be able to access _Fredy_ with your browser. Go to `http://localhost:9000`
### Running Tests ### Running Tests
To run the tests, simply run To run the tests, simply run
```shell ```shell
yarn run test yarn run test
``` ```
@@ -57,24 +57,24 @@ yarn run test
# Architecture # Architecture
![Architecture](/doc/architecture.jpg "Architecture") ![Architecture](/doc/architecture.jpg "Architecture")
## Why is Immoscout missing
Immoscout decided to add "robot protection" to their service. Meaning if Fredy tries to check for listings, it will be recognized as a bot. I haven't found a way around it (yet) ;)
#### Contribution guidelines #### Contribution guidelines
See [Contribution](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTION.md) See [Contribution](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTION.md)
# Docker # Docker
Use the Dockerfile in this Repository to build an image. Use the Dockerfile in this Repository to build an image.
Example: `docker build -t fredy/fredy /path/to/your/Dockerfile` Example: `docker build -t fredy/fredy /path/to/your/Dockerfile`
## Create & run a container ## Create & run a container
Put your config.json to `/path/to/your/conf/` Put your config.json to `/path/to/your/conf/`
Example: `docker create --name fredy -v /path/to/your/conf/:/conf -p 9988:9988 fredy/fredy` Example: `docker create --name fredy -v /path/to/your/conf/:/conf -p 9988:9988 fredy/fredy`
## Logs ## Logs
You can browse the logs with `docker logs fredy -f` You can browse the logs with `docker logs fredy -f`