GradeCheck

This app allows educators to share scores from a Google spreadsheet without giving students direct access to it.

Warning

This project is in the early stages of development. Breaking changes may occur.

Features

Setup

Quick setup instructions for Linux. For more detailed instructions, see the documentation.

• Prepare Google sheets
  • Create a project in Google Cloud console
    • Enable Google Sheets API
    • Create a service account
    • Download and place your credentials.json in this directory
  • Create your sheet (see docs/sheet-format.md)
    • Share it with the service account
• Clone this repository git clone https://github.com/tgrants/gradecheck.git
• Set environment variables
  • Copy template cp .env.example .env
  • Edit it nano .env (see the environment variable documentation)
• Install Docker
  • Get docker compose sudo apt install docker-compose
  • Enable docker sudo systemctl enable docker
  • Start docker sudo systemctl start docker
  • Add user to docker group sudo usermod -aG docker $USER
• Build and start container
  • Development: docker-compose -f docker-compose.dev.yml up --build
  • Production: docker-compose up --build
    • Add -d flag to run in background

Updating

• Read the changelogs
• Pull the latest changes git pull
• Make sure .env has the same values as .env.example
• Rebuild the containers

Contributing

Contributions are welcome. For more information see CONTRIBUTING.md.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for more information.