README.md

French Women's Division 1 table
2022-2023

Simple web scraping tool used to extract data from French Women's Division 1
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The purpose of this project is to familiarize myself with web scraping using JavaScript / NodeJS and Axios. While browsing through the Fédération Française de Football website, I couldn't find a way to download CSV data about the French Women's football league.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• yarn

  yarn set version stable

Installation

1. Clone the repo

   git clone https://github.com/YannAries/web-scraper-d1-arkema.git

2. Install your favorite package manager's packages

• npm

  npm install

• yarn

  yarn install

(back to top)

Usage

Don't abuse this tool. I'm not responsible for any damages caused.

1. Change directory

   cd web-scraper-d1-arkema

2. Run the script

   node src/index.js

3. Check the data saved as a CSV file

   ./dist/assets/d1ArkemaData.csv

4. Check the screenshot saved as a PNG file

   ./dist/assets/image/screenshot.png

(back to top)

Roadmap

• Bypass CAPTCHA verification
• Set the cache timeout for the target webpage
• Migrate from JavaScript to TypeScript

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/Feature)
3. Commit your Changes (git commit -m 'Add some Feature')
4. Push to the Branch (git push origin feature/Feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Yannick - My email address

Project Link: https://github.com/YannAries/web-scraper-d1-arkema

(back to top)

Acknowledgments

• Awesome README template
• Logo of Arkema
• Fédération Française de Football

(back to top)