clarify

Clarify is a web app designed to streamline grading of handwritten essays and responses. It uses optical character recognition (OCR) and Google's PaLM 2 model to provide instant feedback on grammar, structure, and content, helping teachers reduce paperwork and focus on teaching.

https://github.com/soumyojyotisaha/clarify

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Clarify is a web app designed to streamline grading of handwritten essays and responses. It uses optical character recognition (OCR) and Google's PaLM 2 model to provide instant feedback on grammar, structure, and content, helping teachers reduce paperwork and focus on teaching.

Basic Info
  • Host: GitHub
  • Owner: Soumyojyotisaha
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 438 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Citation

README.md

Clarify

Clarify is a web app that helps teachers to grade handwritten essays and responses, providing instant feedback for students, empowering teachers to focus more on teaching and less on paperwork.

Home page of Clarify

Inspiration

Motivated by the challenges faced by overworked teachers and shortage of tools designed for educators in less digitally advanced settings, Clarify aims to ease the burden of grading handwritten essays and responses. Many countries are facing a massive shortage of teachers and in my home country of Bhutan, 416 teachers have left the profession from January to May, so on average more than 83 teachers resign in one month voluntarily. Clarify's main goal is to make grading process more manageable, combat teacher attrition, and ultimately contribute to a positive shift in the education landscape using AI.

What it does

Clarify allows a user to upload images of handwritten essays or response to a question which is then transcribed to digital text using optical character recognition. For the case of an essay, the user provides the essay topic and the using Google's PaLM 2 language model, we provide feedback on how well the topic/question is addressed, grammar, and overall structure. Otherwise for a response to a question, the user provides the question and a reference answer to check how close is the student answer to the reference answer and possible improvements.

How we built it

The web app was developed using next js framework with next-auth for authentication, firebase for database storage, Google cloud vision for optical character recognition, and Google's PaLM 2 language model to generate feedback based on transcribed text.

Challenges we ran into

This was my first time learning how to use firebase and google cloud was so it was difficult initially figuring out how to set up the consoles and api endpoints for calls. Another issue was figuring out how to display to the user the sequence of steps for the digital grading process from upload of images to downloading the feedback in a seamless manner.

Accomplishments that we're proud of

Getting able to setup the user account system, adding and updating documents in firebase storage after making calls google cloud API, and users being able to visualise all their submitted documents along with their feedback.

What we learned

Learning how to create a serverless web application, using services like google cloud console, firebase and talking with users(teachers in our case) for how best such an app would benefit them and what they might want in such an application!

What's next for Clarify

One of the main reasons I wanted to use Google Cloud Vision is due to the wide variety of languages beyond just English including Tibetan which is the same script as for Dzongkha. Currently it does a decent job of extracting Tibetan text for some fonts better than others. However a large language model for languages beyond just English are still in development, so I would love to integrate such that it can support other languages. Also it would be great if students and parents could also have access to the transcribed documents and feedback to make it a more cohesive grading process.

Owner

  • Name: Soumyojyoti Saha
  • Login: Soumyojyotisaha
  • Kind: user
  • Location: VIT VELLORE

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: clarify
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Wangdrak Dorji
    email: wangdrak.dorji@gmail.com
repository-code: 'https://github.com/wdorji/clarify'
abstract: >-
  Clarify is a web app that helps teachers to grade
  handwritten essays and responses, providing instant
  feedback for students, empowering teachers to focus more
  on teaching and less on paperwork.

@misc{OshaPandey,
  author = {Osha Pandey},
  title = {checkd-main},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/OshaPandey/checkd-main/tree/d758279a58ad66cc9fcde4e25b387e77a55dbf8a}},
  commit = {d758279}
}

GitHub Events

Total
Last Year

Dependencies

amplify/package-lock.json npm
  • 869 dependencies
amplify/package.json npm
  • @types/node ^20 development
  • @types/react ^18 development
  • @types/react-dom ^18 development
  • autoprefixer ^10.0.1 development
  • eslint ^8 development
  • eslint-config-next 14.0.1 development
  • postcss ^8 development
  • tailwindcss ^3.3.0 development
  • typescript ^5 development
  • @chakra-ui/icons ^2.1.1
  • @chakra-ui/next-js ^2.2.0
  • @chakra-ui/react ^2.8.2
  • @emotion/react ^11.11.1
  • @emotion/styled ^11.11.0
  • @firebase/firestore ^4.3.2
  • @google-ai/generativelanguage ^1.1.0
  • @google-cloud/vision ^4.0.2
  • @mui/icons-material ^5.14.16
  • @saas-ui/react ^2.3.1
  • array-move ^4.0.0
  • axios ^1.6.1
  • bard-ai ^2.0.3
  • chakra-ui-steps ^1.8.0
  • date-fns ^2.30.0
  • firebase ^10.5.2
  • firebase-admin ^11.11.0
  • google-auth-library ^9.0.0
  • googlebard ^1.0.7
  • net ^1.0.2
  • next 14.0.1
  • next-auth ^4.24.4
  • palm-api ^1.1.1
  • pdfjs-dist ^3.4.120
  • react ^18
  • react-dom ^18
  • react-easy-sort ^1.6.0
  • react-hot-toast ^2.4.1
  • react-icons ^4.12.0
  • react-router-dom ^6.19.0
  • react-to-pdf ^1.0.1
package-lock.json npm