Skip to content

Civic-Interactions-Lab/Clover-Website

Repository files navigation

CLOVER Website

Hosted Here API Docs Report Issue on Jira

Documentation Website Link

Abstract

The CLOVER website provides an interface for users to sign in, view their coding activity, manage class enrollment, and access personalized statistics pulled from the Visual Studio Code extension.

It serves as a companion frontend to the CLOVER API, offering a clean and intuitive UI for students and instructors.

Tech Stack

  • React frontend framework
  • Vite build tool
  • Tailwind CSS for styling
  • ShadCN for components
  • Supabase authentication and database

Getting Started

Install Node

Installation instructions for NodeJS can be found here

Install Dependencies

From the root directory of the project run to install the dependencies

npm install

Run Dev Server

To run the development server use

npm run dev

Building the Dockfile

docker build \ --build-arg SUPABASE_URL=
--build-arg SUPABASE_KEY=
--build-arg BASE_URL= -t clover-website:latest .

Environment Variables

See .env.example for where to get all the variables you will need. Mainly a Supabase project and a Google Gemini API key.

Contributing

We welcome contributions! Please open issues, submit pull requests, or reach out with suggestions.

  1. Fork the repo
  2. Create your branch (git checkout -b feature/thing)
  3. Commit your changes (git commit -am 'Add thing')
  4. Push to the branch (git push origin feature/thing)
  5. Open a pull request

License

This project is licensed under the MIT License. See LICENSE for details.

Collaborators

Jamie
Jaime
Antonio
Antonio
Sophie
Sophie
Nick
Nick
Jack
Jack
ApplebaumIan
Ian Tyler Applebaum

About

Website for the CLOVER Extension's user statistics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages