Skip to content

appinventor-foundation/csta-linking

Repository files navigation

CSTA Standards Linking Tool

Next.js TypeScript TailwindCSS

A tool designed to help educators, teachers, and policymakers better determine how their curriculum aligns with Computer Science Teachers Association (CSTA) standards. This application provides a PDF analysis tool to identify relevant standards in educational materials.

Table of Contents

Features

PDF Analysis Tool

Upload educational materials (PDF format) to:

  • Automatically identify relevant CSTA National standards
  • View matching state standards
  • Adjust confidence thresholds for matches
  • See detailed information about each standard

Technologies

  • Frontend: Next.js, React, TailwindCSS
  • Backend: Next.js API routes
  • Database: PostgreSQL with Prisma ORM
  • AI: OpenAI API for content analysis
  • Vector Database: Pinecone for semantic search
  • Data Processing: Custom data processing for standards data

Setup

Prerequisites

  • Node.js (v18 or higher)
  • Yarn
  • PostgreSQL database
  • OpenAI API key
  • Pinecone API key

Environment Variables

Create a .env file in the root directory with the following variables:

# Database
DATABASE_URL="postgresql://username:password@localhost:5432/csta_standards"

# OpenAI
OPENAI_API_KEY="your-openai-api-key"

# Pinecone
PINECONE_API_KEY="your-pinecone-api-key"

Setting Up PostgreSQL

  1. Install PostgreSQL if you haven't already
  2. Create a new database:
    createdb csta_standards
  3. Update the DATABASE_URL in your .env file with your PostgreSQL credentials

For more information on setting up PostgreSQL, refer to the official documentation.

Obtaining API Keys

  • OpenAI API Key: Sign up at OpenAI Platform and create an API key
  • Pinecone API Key: Create an account at Pinecone and create an API key

Installation

  1. Clone the repository:

    git clone https://github.com/appinventor-foundation/csta-linking.git
    cd Data-Processing
  2. Install dependencies:

    yarn install
  3. Generate Prisma client:

    yarn generate
  4. Start the development server:

    yarn dev
  5. Open http://localhost:3000 in your browser to see the application.

Usage

PDF Analysis

  1. Navigate to the PDF Analysis page by clicking "Analyze PDF" on the home page
  2. Upload a PDF file containing educational material
  3. Select a state (optional) to see state-specific standards
  4. Adjust the confidence threshold as needed
  5. Click "Upload and Analyze" to process the document
  6. View the matching CSTA standards and related state standards

About

Web tool that scans curriculum PDFs to pinpoint and highlight their alignment with CSTA standards

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published