Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/santinic/hackwage
RSS/JSON Aggregator and Search Engine for IT Jobs
https://github.com/santinic/hackwage
Last synced: 5 days ago
JSON representation
RSS/JSON Aggregator and Search Engine for IT Jobs
- Host: GitHub
- URL: https://github.com/santinic/hackwage
- Owner: santinic
- License: gpl-3.0
- Created: 2019-02-15T07:42:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T14:45:49.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T16:42:44.969Z (3 months ago)
- Language: JavaScript
- Homepage: https://hackwage.com
- Size: 1.78 MB
- Stars: 49
- Watchers: 4
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [hackwage.com](https://hackwage.com)
Hackwage is a RSS/JSON aggregator and search-engine for IT Jobs.
It can be easily adapted for other projects, for example to fetch and search News.
The website is based on Python/Django and ElasticSearch, while the live data is ingested via NodeJS.
[
](https://hackwage.com)
## How to run it (Debian)
#### Create Python Virtual Env
```
$ git clone https://github.com/santinic/hackwage.git
$ cd hackwage
$ virtualenv -p python3 venv3
$ source venv3/bin/activate
$ pip install -r requirements.txt
```
#### Run ElasticSearch
Install the latest ElasticSearch on your Debian box,
[as documented here](https://www.elastic.co/guide/en/elasticsearch/reference/current/deb.html).
Then start it:
```
$ sudo systemctl start elasticsearch
```
#### Setup NodeJS and start ingesting data
```
$ cd node
$ npm install
$ npm run ingest
```
The script will try to fetch all the default data sources, you shouldn't get any error at this stage.
#### Setup a Cron Job
You can set up a cronjob to fetch data every hour.
Just run `crontab -e` and add a line like this:
```
0 * * * * cd /hackwage-path/node/ && npm run ingest >/dev/null 2>&1
```
#### Setup and run Django server
```
$ ln -s `pwd`/dj/dev_settings.py dj/settings.py
$ python manage.py migrate
$ python manage.py runserver
```
Now you should be able to access hackwage on you local machine on port 8000.
#### Cache
Hackwage makes use of Memcached cache the home page.
It's already set up in the default settings, so you just need to
install and run Memecached:
```
$ sudo apt install memcached
$ sudo systemctl start memcached
```
## Adding RSS sources
You can add any number of RSS source url, editing the file `/sources.json`.
It should be a JSON file with a list of objects structured like this one:
```json
{
"name": "StackOverflow Jobs",
"url": "https://stackoverflow.com/jobs/feed",
}
```
## Elasticsearch Mappings
Elasticsearch works out of the box with any JSON blob of data.
But to get decent search results and index only what is necessary, you might
want to setup the object mappings.
Hackwage uses an "rss" index and a "item" doc_type.
You can configure the mappings doing this `PUT` request:
`PUT http://localhost:9200/rss/item/`
```json
{
"item": {
"properties": {
"title": {
"type": "text",
"analyzer": "english"
},
"body": {
"type": "text",
"analyzer": "english"
},
"body_html": {
"type": "keyword"
},
"category": {
"type": "keyword"
},
"link": {
"type": "keyword"
},
"pubDate": {
"type": "date"
},
"source": {
"type": "keyword"
}
}
}
}
```
## Todo
- Dockerize, anyone ?
## Hackwage clones ?
Hackwage is distributed under GPL3. So you can deploy as many clones
of hackwage.com as you wish, as long as you link back to this page
and share any improvements you made to it.