Palette 🎨

An interactive rubric builder and grading assistant tool to improve the group project grading experience on Canvas.

Table of Contents

1. Requirements
2. Startup Instructions
   • Running with Docker
   • Running without Docker
3. Shutting Down
4. Troubleshooting

---

Requirements

Palette runs in a Docker container, providing the necessary Node environment. Make sure you have the following installed:

• Docker: Install Docker
• Docker Compose: Install Docker Compose

Check your installations with:

docker --version
docker-compose --version

---

Startup Instructions

Running with Docker

1. Clone the repository and navigate to the root folder:

   git clone <repository-url>
   cd palette

2. Run one of the following commands to start the services:

   docker-compose up        # Attached mode
   docker-compose up -d     # Detached mode

   This will build and start the container, including a PostgreSQL database, on any OS.

3. Stopping the Containers

   • Use CTRL + C if in attached mode or docker-compose down if detached.

Running without Docker

If you have Node.js (version 18+) and PostgreSQL installed:

1. After cloning the repo, run:

   npm install && npm run dev

2. For local PostgreSQL, create a .env file:

   echo "DATABASE_URL=postgres://<username>:<password>@localhost:5432/<database_name>" > backend/.env

---

Shutting Down

Stopping Containers

• To stop services and remove containers:

  docker-compose down

• Removing Volumes and Images
  For a complete cleanup:

  docker-compose down --volumes --rmi all

• Optional:
  To remove unused resources:

  docker system prune --all --volumes

---

Troubleshooting

1. Permissions Issues
   Ensure Docker is running, and check that your user is in the docker group. For persistent issues, run with sudo.

2. Checking Logs

   docker-compose logs

3. Rebuild Containers
   After changes:

   docker-compose up --build

4. Network Issues
   Verify port 5173 is free.

---

Usage

Once up and running, you can interact with the application on http://localhost:5173. Check out the rubrics builder to add and manage grading rubrics directly within Canvas.