Skip to content

ktwu01/school-evaluator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

School Evaluator | Compare School Offers

Scientific evaluation tool to help you make informed decisions when comparing school offers and opportunities.

Website GitHub stars GitHub forks License


Live Demo

Visit: https://ktwu01.github.io/school-evaluator/

Available in 5 languages: English | 中文 | Español | Français | 日本語


Key Features

Comprehensive School Comparison

Evaluate and compare up to 2 schools across multiple dimensions:

  • Financial Analysis: Tuition, scholarships, living costs
  • Program Details: Length, post-graduation salary expectations
  • Personal Preferences: School reputation, location fit, program alignment
  • ROI Calculation: Automatic return on investment estimation

Smart Features

  • Financial Calculator - Calculates net cost and 5-year ROI
  • Weighted Scoring - Combines financial and personal factors
  • Data Management - Import/export comparisons, local storage
  • Multi-language - Full support for 5 languages
  • Responsive Design - Works perfectly on desktop and mobile
  • Privacy First - All data stored locally, never uploaded

Quick Start

For Users

Simply visit the live site: ktwu01.github.io/school-evaluator

No installation required!

For Developers

# Clone the repository
git clone https://github.com/ktwu01/school-evaluator.git
cd school-evaluator

# Install dependencies
npm install

# Start development server
npm run dev

Visit http://localhost:3000

Build for production:

npm run build

Test locally (simulates GitHub Pages):

./test-github-pages.sh

Documentation


Technology Stack

  • Framework: Next.js 15 + TypeScript
  • UI Library: shadcn/ui (Radix UI + Tailwind CSS)
  • Internationalization: next-intl (5 languages)
  • Icons: Lucide React
  • Deployment: GitHub Pages + GitHub Actions

How It Works

  1. Enter School Info - Name, tuition, scholarships, living costs
  2. Add Program Details - Length and expected post-grad salary
  3. Rate Personal Preferences - Reputation, location, program fit (1-10 scale)
  4. Compare Schools - Side-by-side analysis with scores
  5. Export Data - Save and share your comparisons

Evaluation Components

Financial Metrics:

  • Net cost per year (tuition - scholarship + living costs)
  • Total program cost
  • 5-year ROI based on expected salary

Weighted Score: Combines financial value with personal preference ratings:

  • School reputation
  • Location preference
  • Program fit

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/AmazingFeature
  3. Commit your changes: git commit -m 'Add some AmazingFeature'
  4. Push to the branch: git push origin feature/AmazingFeature
  5. Open a Pull Request

Development Guidelines

  • Use TypeScript for type safety
  • Follow Biome code standards
  • Write functional React components
  • Use Tailwind CSS for styling
  • Test on both desktop and mobile

License

This project is licensed under CC BY-NC-ND 4.0

  • ✅ Free to use and share
  • ❌ No commercial use
  • ❌ No modifications/derivatives

⚠️ Disclaimer

  • Reference Tool Only - Use as one factor among many in your decision-making
  • Privacy Protected - All data stored locally in your browser
  • Subjective Evaluation - Results based on your personal judgment
  • Your Responsibility - Final decision rests with you

Links


Recent Updates

v1.0.0 (Latest)

  • ✅ 5-language support (EN, ZH, ES, FR, JA)
  • ✅ Side-by-side school comparison
  • ✅ Financial analysis with ROI calculation
  • ✅ Weighted scoring system
  • ✅ GitHub Pages deployment
  • ✅ Import/export functionality
  • ✅ Responsive mobile design

If this tool helps you, please give it a ⭐ Star!

May every student find their ideal school and thrive in their academic journey!

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •