Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luqueee/moodle-rest-scraper
Rest API express with puppeteer library for scraping information of a user
https://github.com/luqueee/moodle-rest-scraper
express moodle puppeteer
Last synced: about 1 month ago
JSON representation
Rest API express with puppeteer library for scraping information of a user
- Host: GitHub
- URL: https://github.com/luqueee/moodle-rest-scraper
- Owner: Luqueee
- Created: 2024-09-13T21:52:18.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T22:21:52.000Z (2 months ago)
- Last Synced: 2024-10-12T22:21:34.844Z (about 1 month ago)
- Topics: express, moodle, puppeteer
- Language: TypeScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Moodle Course and Session Scraper**
A web scraper designed for extracting course and session information from Moodle, tailored for educational institutions or users looking to automate the process of retrieving their course data.
---
## **Table of Contents**
- [**Moodle Course and Session Scraper**](#moodle-course-and-session-scraper)
- [**Table of Contents**](#table-of-contents)
- [**Installation**](#installation)
- [**Usage**](#usage)
- [**Deploying with PM2**](#deploying-with-pm2)
- [**Contributing**](#contributing)
- [License](#license)
---
## **Installation**
Follow these steps to set up the development environment:
1. **Clone the repository:**
```bash
git clone https://github.com/moodle-tracker/moodle-rest-api.git
```
2. **Navigate to the project directory:**
```bash
cd moodle-rest-api
```
3. **Install the required dependencies:**
```bash
npm install
```
---
## **Usage**
Run the application locally using the following command:
```bash
npm run dev
```
## **Deploying with PM2**
To deploy the application using PM2 on a Debian system:
1. **Install PM2 globally:**
```bash
npm install pm2 -g
```
2. Set up the PM2 script:
```bash
chmod +x pm2.sh
./pm2.sh
```
## **Contributing**
1. **Fork the repository.**
2. **Create a new feature branch:**
```bash
git checkout -b feature-branch
```
3. **Make your changes and commit them:**
```bash
git commit -m 'Add some feature'
```
4. **Push the branch to your fork:**
```bash
git push origin feature-branch
```
5. **Open a pull request to the main repository.**
## License
This project is licensed under the MIT License. See the [License](License) file for more details.