Sparx Maths Bookwork Automation

This project automates the process of saving bookwork codes each time a student answers a question in Sparx Maths.

Getting Started

These instructions will help you set up the project and start using it.

Prerequisites

You will need to have the following installed on your computer:

• Node.js
• NPM
• Puppeteer

Installing

Clone the repository to your local machine.

git clone https://github.com/marcussaw123/sparx-v2.git

Navigate to the project directory.

cd sparx-v2

Install the necessary dependencies.

npm install

Configuring the Project

Locate the file example.env you should find the following:

password=pass
username=username
url=sparx school url

Change the values above to your own username, password and school url. Save the file as .env.

Running the Project

To start the project, run the following command.

node index.js

How it works

The project uses Puppeteer to automate the process of saving bookwork codes each time a student answers a question. When a question is answered, the code takes a screenshot of the question and the answer and saves it to the bookwork-codes folder in the main directory. This eliminates the need for students to manually record the bookwork codes in their books, as the code does it automatically. The advantage of using JavaScript and Puppeteer is that the code is able to save the bookwork codes from any type of question, as long as it is presented on the screen.

Built With

• JavaScript
• Puppeteer
• Node.js
• NPM

Acknowledgements

This project is inspired by Gwyd0's Sparx-bwk project on GitHub. Thank you Gwyd0 for the inspiration!

Sample Images