Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.45 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.45 KB
Raw

GitHub Classroom Lock

Locks a GitHub Classroom by removing all students from their team. It keeps track of the students that were removed to allow restoring them later.

This helps us restrict access when students leave our school.

Getting Started

  1. Clone this repository
  2. Run composer install
  3. Copy .env.example to .env and fill in the values (see #Access Tokens for more info)
  4. Run php artisan key:generate
  5. npm run dev to run vite and compile the frontend (watching for changes)
  6. php artisan serve to run the server
  7. Open http://localhost:8000 in your browser
  8. Run php artisan migrate to create the database

Access Tokens

GitHub access token

  1. Get a Fine-grained access token from GitHub here.
  2. Select the curio-summatief organization
  3. Give it the following permissions:
    • Organization permissions:
      • Members: read and write
    • (Optional) Repository permissions:
      • Contents: read

OpenAI access token

  1. Get an OpenAI API key here.
  2. Copy the key and paste it in the .env file as OPENAI_API_KEY.
  3. Make sure you've prepaid some money to your OpenAI account.

Notes:

cURL error 60: SSL certificate expired

To test locally it can be useful to add SD_SSL_VERIFYPEER=no to your .env file. This disables SSL verification, which is not recommended for production.