Giter Site home page Giter Site logo

jacksonrakena / gradekeeper Goto Github PK

View Code? Open in Web Editor NEW
7.0 1.0 0.0 1.73 MB

A free, open-source grade tracking site used by 500+ students at 15+ universities and colleges around the world

Home Page: https://gradekeeper.xyz

JavaScript 0.64% TypeScript 96.87% CSS 0.17% HTML 2.33%
education grade-calculator gradebook grades grade-tracking hacktoberfest

gradekeeper's Introduction

Gradekeeper

Try it now: gradekeeper.xyz

API Client
Better Stack Badge Better Stack Badge

Gradekeeper is an free, open-source Rust + React web app that simplifies grade tracking and projections for university students across the globe.

This repository holds the TypeScript/React based client. For the Rust/Axum-based API server, see jacksonrakena/gradekeeper-server.

Running a developer environment

You'll need Node 16 and NPM/Yarn installed. This guide will use NPM. You'll also need a Rust compiler that supports the 2021 edition.

Server

First, clone jacksonrakena/gradekeeper-server.

  1. Configure the parameters:

You'll need to copy .env.template to .env and fill out the fields.

Field name Description
DATABASE_URL A Postgres connection string.
JWT_SECRET A random string of any length, used to encrypt JWTs.
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET Your Google credentials for login. You can get these from the Google Cloud Console.
PERMITTED_REDIRECT_URLS A list of comma-separated permitted URLs. For example, the production server uses https://app.gradekeeper.xyz. For development, set this to something like http://localhost:5173.
  1. Run the API server in release mode.
cargo run --release

Client

First, clone jacksonrakena/gradekeeper.

  1. Install dependencies:
npm i
  1. Configure the client:

Create a file called .env.local and fill in values as per the below table:

Field name Description
VITE_API_BASE_URL The base url of the API server. For development, set this to something like http://localhost:3000.
  1. Start the development server:
npm run dev
  1. Visit the development server on the address that Vite generates.

Screenshots

Home page:
image

Copyright

Gradekeeper is copyright ยฉ 2022โ€”2024 Jackson Rakena.

gradekeeper's People

Contributors

jacksonrakena avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

gradekeeper's Issues

Add Export to CSV Feature

It would be beneficial to have an export to CSV feature that allows users to download their grade data in a CSV format. This feature would help users easily share or analyze their grades outside of the application.

  • Add an "Export to CSV" button in the user dashboard.
  • Implement a function to convert grade data into CSV format.
  • Provide options to export all grades or filtered views.
  • Consider compatibility with various spreadsheet applications (e.g., Excel, Google Sheets).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.