[Chore] Contributor Documentation

masterofn0n3 / scraper

Backend service for simple google search result scrapper

0 stars 0 forks source link

[Chore] Contributor Documentation #5

Open malparty opened 8 months ago

malparty commented 8 months ago

Issue

Some important documentation is missing, such as:

How to run the application in dev mode with hot-reload
How to run the tests

As an extra, some notes about the project architecture and the references to the templates used to scaffold the app are highly appreciated, though less "important".

masterofn0n3 commented 7 months ago

Thank you! I will include this information in the README. When I initially wrote it, my intention was to assist readers in running the application with minimal difficulties, which led me to omit this particular detail.