Skip to content

Update version2 readme #28

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

Merged
dendenso merged 2 commits into from
Apr 25, 2025
Merged

Update version2 readme #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4796a4e
Add technical documentation to README (task 17)
gmanhas12 Apr 24, 2025
f7efa55
Merge remote-tracking branch 'origin/primary' into update-readme
gmanhas12 Apr 24, 2025
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# Cheaper.com
Initial Landing page![Initial Landing page](https://github.com/user-attachments/assets/7d2a1c73-0d16-4965-a2f8-4402ef267ff4)





##Technical Documentation of how to run the application

#How to run

-To run the scraper, execute the main.py script by running the command

python main.py

-Make sure you are in the src directory when you run the command (the directory that contains main.py).

##Where is the entry point?

-The entry point is the main() in main.py, specifically, this block of code,
if __name__ == "__main__":
main()


##what file needs to be located and what variables would need to be changed if you wanted to scrape another website?

-If you wanted to scrape another website, you need to locate the file main.py and change the variables “scraper” and “pages” to whatever website you wanted and the new URl paths. As well ensure the website allows scraping.