{"id":28166456,"url":"https://github.com/finki-hub/finki-scraper","last_synced_at":"2025-05-15T13:13:28.361Z","repository":{"id":106869283,"uuid":"533551474","full_name":"finki-hub/finki-scraper","owner":"finki-hub","description":"Scripts for scraping various FINKI services, and providing them by a Discord webhook and a REST API","archived":false,"fork":false,"pushed_at":"2025-05-05T13:05:22.000Z","size":1819,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T13:41:12.796Z","etag":null,"topics":["fcse","finki","ukim"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/finki-hub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-07T00:56:30.000Z","updated_at":"2025-05-05T12:30:49.000Z","dependencies_parsed_at":"2023-11-17T19:58:52.700Z","dependency_job_id":"700d8cf6-b28f-4036-919c-0626ebf1c7a9","html_url":"https://github.com/finki-hub/finki-scraper","commit_stats":null,"previous_names":["finki-hub/finki-scraper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-scraper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-scraper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-scraper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-scraper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/finki-hub","download_url":"https://codeload.github.com/finki-hub/finki-scraper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254346600,"owners_count":22055809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fcse","finki","ukim"],"created_at":"2025-05-15T13:12:21.221Z","updated_at":"2025-05-15T13:13:28.352Z","avatar_url":"https://github.com/finki-hub.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FINKI Scraper\n\nTooling for scraping and providing publicly available data from FCSE services. The data is provided using a REST API or webhooks. Requires Node.js \u003e= 20.\n\n## Architecture\n\nThe scrapers are implemented as classes (called strategies) which contain several selectors and methods for fetching the data from each container (post, announcement, etc). Adding a new service requires creating a new strategy and linking it. See [the example strategy](./src/strategies/ExampleStrategy.ts) for more info.\n\n## Quick Setup (Production)\n\nTo run the scraper:\n\n1. Clone the repository: `git clone https://github.com/finki-hub/finki-scraper.git`\n2. Prepare configuration by copying `config/config.sample.json` to `config/config.json`\n3. Install dependencies: `npm i`\n4. Run the scraper `npm run start`\n\nIt's also available as a Docker image:\n\n```sh\ndocker run -d \\\n  --name finki-scraper \\\n  --restart unless-stopped \\\n  -v ./cache:/app/cache \\\n  -v ./config:/app/config \\\n  -v ./logs:/app/logs \\\n  ghcr.io/finki-hub/finki-scraper:latest\n```\n\nOr Docker Compose: `docker compose up -d`\n\nYou can select which scrapers to run declaratively (in the configuration with the `enabled` flag) or imperatively: `npm run start scraper_1 scraper_2 ... scraper_n`\n\n## Quick Setup (Development)\n\n1. Clone the repository: `git clone https://github.com/finki-hub/finki-scraper.git`\n2. Install dependencies (and pre-commit hooks): `npm i`\n3. Prepare configuration: `cp config/config.sample.json config/config.json`\n4. Build the project: `npm run build`\n5. Run it: `npm run start`\n\n## Configuration\n\nThere is an example configuration file available at [`config/config.sample.json`](./config/config.sample.json). Copy it to `config/config.json` and edit it to your liking.\n\n## Server Mode\n\nIf you would like to consume the data from a REST API, run the app in server mode: `npm run serve`. The data will be scraped on each API call instead of periodically.\n\n- `GET /list` - get all active scrapers,\n- `GET /get/\u003cname\u003e` - get data from the scraper `\u003cname\u003e`\n- `DELETE /delete` - delete the cache of all scrapers\n- `DELETE /delete/\u003cname\u003e` - delete the cache of the scraper `\u003cname\u003e`\n\nThe `\u003cname\u003e` parameter is what is specified in the configuration.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinki-hub%2Ffinki-scraper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinki-hub%2Ffinki-scraper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinki-hub%2Ffinki-scraper/lists"}