Skip to content

[Improve] Update the main README.md, CONTRIBUTING.md and Scrapper-Service/README.md #40

@thesagarsehgal

Description

@thesagarsehgal

Some of the improvements that must be added to the main README.md file.

  • In the Prerequisites section, for the various tools like Mongo DB, Angular, etc., please provide a link to the installation instructions for Windows and Linux systems.
  • The /Scrapper-Service folder has requirements.txt file. Please add instructions for creating the virtual environment and installing the /Scrapper-Service/requirements.txt.
  • For Deployment of Scrapper-Service section, in the instructions, change main.py to app.py.
  • For Deployment section, separate all the commands into different blocks, instead of putting all of them in one block. Further, please remove the >> symbol in the beginning, because currently, it becomes difficult to copy the complete command in a double click.
  • Also, similar work has to be done in the ATTENTION section of CONTRIBUTING.md file for separating all the commands into different blocks, instead of putting all of them in one block.
  • Add instructions on how to run the Scraper Service in different modes in the /Scrapper-Service/README.md.

Metadata

Metadata

Labels

beginnerGSSOC label for beginner tagdocumentationImprovements or additions to documentationgood first issueGood for newcomersgssoc20GSSOC label for gscco20 tag

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions