Frontend for HomeWorked, an example school homework marking system, as seen from a teachers view.

To be run in conjunction with the backend. Found here:

https://github.com/ParadigmZero/homeworked-backend

Setup

Node and npm must be installed.

Recommend to use Node Version Manager (nvm) then in this directory enter:

nvm use

Which will install a version of Node confirmed to work with this project.

Then install node modules .etc:

npm i --legacy-peer-deps

Running

npm start

Data structures

homework object

Example:

  {
    name: `English - Conjunctions`,
    image: `${host}eng.PNG`,
    dateSet: `September 14th, 2020`,
    dateDue: `Wednesday`,
    comment:
      `Complete each sentence using the correct conjunction. Make sure to read the sentences carefully as you will be using them in class later this week.`,
    children: [...children],
  }

child object ( children / classroom )

Example:

  {
    name: "Amelia",
    avatar: `${host}1.png`,
    individualHomeworkImage: null,
    annotation: null,
    comment: null
}

Environmental variables for AWS S3 upload

You will need to input the following environmental variables into a .env file ( root directory).

These relate to an Amazon AWS S3 bucket. For security reasons these cannot be given, and you will need to create your own.

(Place them after the = sign )

REACT_APP_BUCKETNAME=
REACT_APP_REGION=
REACT_APP_ACCESS_KEY_ID=
REACT_APP_SECRET_ACCESS_KEY=