Skip to content

docs: update docs , how to crawl on local machine #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update docs , how to crawl on local machine #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,22 @@ This API data source comes from the combination of several parameters from [api.
- [x] Audio (***Syekh. Mishary Rashid Al-Afasy*** murrotal edition)
- [ ] Your requests ?

### Crawl Quran data on local machine
If you want to crawl new quran data on your local machine (after clone this repo, and install depedency with `npm/yarn`), do following steps:

1. Download `quran-tafsir.json` file (download [here](https://github.com/gadingnst/quran.machine/blob/main/src/app/data/quran-tafsir.json) ) and save it on `'data'` folder.
2. Configure `.env.example` file , rename it to `.env`.
3. Configure the base url (on your `.env` file).

```
# Data Source Endpoint for Crawler (NOT USED IN PRODUCTION)
SOURCE_API_BASEURL=http://api.alquran.cloud/v1
SOURCE_API_BASEURL_2=https://api.npoint.io/99c279bb173a6e28359c/data
```

3. Done, run the crawl command. (`npm run crawl` or `yarn run crawl`).


### Data Source
- [api.alquran.cloud](https://api.alquran.cloud) = Quran, Meta Verses, Audio.
- [quran.kemenag.go.id](https://quran.kemenag.go.id) = Indonesia translations and tafsir verses (short/long).
Expand Down