Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1.17 KB

Contributing to Hatt

Thanks for taking some time to contribute to Hatt, this is what makes open source projects alive !

Feel free to open an issue or a github discussion if you have any question.

Local setup

Dependencies

The following dependencies are needed to run the program :

  • Go (1.18+)
  • NPM (Node 15+)
  • Wails

The other dependencies (npm and go libraries) will be installed in the first run

Start developpement server

wails dev

Build Hatt

wails build

More informations here

Adding sources

Sources can be scraped with 2 different methods :

  • By using the ScrapePlainHtml function, which parses the html response to a request. A source can be scraped like this if the html is generated server-side (it is in most cases). To add a source like this, create a file source-name.json and complete it based on an already existing source.json file.
  • By creating a specific scraper. This method is used only if the ScrapePlainHtml function can't be used for the source, or if there is an API for the source. This is to prevent code redundancy.