s500042/webscraper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README to correct script paths and improve instructions
Some checks are pending
Docker Image CI / build (push) Waiting to run
Details

Browse Source
This commit is contained in:
patilk 2024-11-15 22:40:07 +01:00
parent 6f3567982d
commit ba9e42b9c6
Signed by: s500042
GPG Key ID: 1921AD722E7392EE
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -15,7 +15,7 @@ This project is a web scraper designed to extract data from websites.
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://git.wmi.amu.edu.pl/s500042/webscraper git clone https://git.wmi.amu.edu.pl/s500042/webscraper
``` ```
2. Navigate to the project directory: 2. Navigate to the project directory:
@ -27,44 +27,48 @@ cd webscraper
3. Build the Docker image and run it using `start.py` script: 3. Build the Docker image and run it using `start.py` script:
```bash ```bash
python start.py python scripts/start.py
``` ```
On Mac, you'll have to use On Mac, you'll have to use
```bash ```bash
python3 start.py python3 scripts/start.py
``` ```
4. Check `/app/dist/data.json` file to see the extracted data.
### Without Docker ### Without Docker
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/yourusername/webscraper.git git clone https://git.wmi.amu.edu.pl/s500042/webscraper
``` ```
2. Install the required dependencies: 2. Install the required dependencies:
```bash ```bash
pip install -r requirements.txt pip install -r app/requirements.txt
``` ```
If you're on Arch Linux, you'll need to create a virtual environment. If you're on Arch Linux, you'll need to create a virtual environment.
Here's is a [Step by step guide](#) that will help you create it. Here's is a [Step by step guide](#) that will help you create it.
3. Run `run-with-no-docker.py` script: 3. Run `run_with_no_docker.py` script:
```bash ```bash
python run-with-no-docker.py python scripts/run_with_no_docker.py
``` ```
On Mac you'll, need to use: On Mac you'll, need to use:
```bash ```bash
python3 run-with-no-dcoker.py python3 scripts/run_with_no_docker.py
``` ```
4. Check `/app/dist/data.json` file to see the extracted data.
## License ## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.