📚 GPA Calculator

A modern, secure web application for calculating and tracking your GPA across semesters. Built with Firebase, Vite, and Google Sign-In for seamless authentication and data synchronization.

✨ Features

Core Functionality

📊 GPA Calculator - Calculate semester and cumulative GPA
📈 Analytics Dashboard - Visualize your academic progress with charts
💾 Semester Management - Create, edit, and delete semesters
📝 Course Tracking - Add/remove courses with grades and credits
📋 Grade History - View all past grades and calculations
🎓 Grade Info Reference - Grade scales and conversion information

User Experience

🌙 Dark/Light Mode - Toggle between themes
📱 Fully Responsive - Works seamlessly on mobile and desktop
🔄 Cloud Sync - All data synced with Firebase
⚡ Fast & Instant - Built with Vite for optimal performance
🔐 Secure - Firebase Authentication with Google Sign-In

Data Management

🔑 Google Authentication - Sign in with your Google account
👤 Guest Mode - Calculate without signing in
☁️ Cloud Storage - Data persisted in Firebase Realtime Database
📊 Export Ready - Easy access to your academic data

🚀 Quick Start

Prerequisites

Node.js 16+ and npm
A Firebase project (free tier available)
Google account (for Google Sign-In setup)

Installation

Clone the Repository

git clone https://github.com/yourusername/GPA-Calculator.git
cd GPA-Calculator

Install Dependencies

npm install

Configure Environment Variables

# Copy the example file
cp .env.example .env

# Edit .env with your Firebase credentials
# Get them from Firebase Console: https://console.firebase.google.com/

Start Development Server

npm run dev

Open http://localhost:5173 in your browser.

🔒 Security & Configuration

Environment Variables

Firebase credentials are managed through environment variables using Vite:

# 1. Copy the example file
cp .env.example .env

# 2. Edit .env and add your Firebase credentials
# Get them from: https://console.firebase.google.com/ → Project Settings

Your .env file should contain:

VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your-project.firebaseapp.com
VITE_FIREBASE_PROJECT_ID=your-project-id
VITE_FIREBASE_STORAGE_BUCKET=your-project.firebasestorage.app
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
VITE_FIREBASE_MEASUREMENT_ID=your_measurement_id
VITE_FIREBASE_DATABASE_URL=https://your-project.firebaseio.com

Important Note: Firebase web API keys are public by design and safe to expose. Security is enforced through:

✅ Firebase Security Rules (see database.rules.json)
✅ User authentication requirements
✅ Domain restrictions in Firebase Console

See SECURITY.md for detailed security information.

Deployment

For production deployment to Vercel, Netlify, or other platforms:

Set environment variables in your hosting platform dashboard
All VITE_FIREBASE_* variables must be configured
See VERCEL_DEPLOYMENT.md for detailed Vercel instructions

📖 Setup Guide

Firebase Configuration

Create a Firebase Project
- Go to Firebase Console
- Click "Create Project"
- Enter project name (e.g., "GPA Calculator")
- Enable Google Analytics (optional)
Get Firebase Credentials
- Go to Project Settings (⚙️ icon)
- Copy your web app configuration
- Add the values to .env file
Enable Google Sign-In
- Go to Authentication → Sign-In Method
- Enable Google provider
- Add project name and support email
- Save changes
Configure Authorized Domains
- In Authentication → Settings → Authorized Domains
- Add localhost and localhost:5173 for development
- Add your production domain later

Set Up Realtime Database

Go to Realtime Database
Create database in test mode (for development)
Update security rules for production:

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "$uid === auth.uid",
        ".write": "$uid === auth.uid"
      }
    }
  }
}

📖 Full Setup Guide: See GOOGLE_LOGIN_SETUP.md

🛠️ Development

Available Commands

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

# Install new dependencies
npm install

Project Structure

GPA-Calculator/
├── index.html                   # Main application
├── login.html                   # Google Sign-In page
├── vite.config.js              # Vite configuration
├── package.json                # Dependencies
├── .env                        # Firebase credentials (secret)
├── .env.example                # Template for .env
├── README.md                   # This file
├── GOOGLE_LOGIN_SETUP.md       # Authentication setup
└── SETUP.md                    # Original setup guide

Technology Stack

Frontend: HTML5, CSS3, JavaScript (ES6+)
Build Tool: Vite
Authentication: Firebase Auth + Google Sign-In
Database: Firebase Realtime Database
Hosting: Ready for Firebase Hosting / Vercel / Netlify
Styling: CSS3 with CSS Variables for theming

🤝 Contributing

We'd love to have you contribute! Whether you're fixing bugs, adding features, or improving documentation, all contributions are welcome.

How to Contribute

Fork the Repository
- Click the "Fork" button on GitHub
- Clone your fork: git clone https://github.com/yourusername/GPA-Calculator.git
Create a Feature Branch
```
git checkout -b feature/amazing-feature
```
Make Your Changes
- Write clean, readable code
- Follow existing code style
- Test your changes locally

Commit Your Changes

git add .
git commit -m "Add: amazing-feature description"

Push to Your Fork
```
git push origin feature/amazing-feature
```
Open a Pull Request
- Go to the original repository
- Click "New Pull Request"
- Describe what you changed and why
- Wait for review and feedback

Contribution Guidelines

✅ Write descriptive commit messages
✅ Keep commits focused on one feature/bug fix
✅ Test changes in both light and dark modes
✅ Test on mobile and desktop
✅ Update documentation if needed
✅ No console errors or warnings

Code Style

// Use arrow functions
const calculateGPA = (courses) => {
  // Clear variable names
  const totalCredits = courses.reduce((sum, c) => sum + c.credits, 0);
  return totalCredits > 0 ? gpa : 0;
};

// Use meaningful names
const semester = {
  name: "Fall 2025",
  courses: [],
  gpa: 0.0,
};

📋 Feature Requests & Bug Reports

Found a bug or have an idea? Help us improve!

Report a Bug

Check if the bug was already reported in Issues
Click "New Issue" → select "Bug Report"
Describe the bug in detail:
- What were you trying to do?
- What happened instead?
- Steps to reproduce
- Browser and device info

Request a Feature

Check if the feature was already requested
Click "New Issue" → select "Feature Request"
Describe the feature:
- What problem does it solve?
- How would you use it?
- Rough idea of how it might work

👥 Collaborators

We're actively looking for collaborators! Here are some areas where we could use help:

Wanted: Developers

🐛 Bug Fixes - Find and fix issues
✨ New Features - Add cool functionality
🎨 UI/UX Improvements - Make it look and feel better
📊 Advanced Analytics - Better charts and insights

Wanted: Designers

🎨 UI Design - Improve visual appearance
📱 Mobile UX - Optimize for mobile devices
🌈 Themes - Create additional color schemes
📐 Wireframes - Plan out new features

Wanted: Documentation

📝 Write Guides - Create tutorials for users
🌐 Translate - Help with internationalization
👨‍💻 Code Comments - Document complex functions
📚 API Docs - Document Firebase integration

Areas for Improvement

📞 Get in Touch

Want to collaborate or just have questions?

GitHub Issues: Report bugs or request features
GitHub Discussions: Join our community
Email: your-email@example.com
Twitter: @yourusername

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

What You Can Do

✅ Use for personal projects
✅ Modify and redistribute
✅ Use commercially
✅ Private use

What You Must Do

📋 Include license and copyright notice
📋 State significant changes

🔐 Security

Reporting Security Issues

⚠️ Do not open a public GitHub issue for security vulnerabilities.

Instead, email security concerns to: your-email@example.com

We take security seriously and will respond within 24 hours.

Security Best Practices

✅ Firebase credentials stored in .env (never committed)
✅ Google OAuth 2.0 for secure authentication
✅ Firebase Security Rules protect user data
✅ HTTPS enforced in production
✅ No sensitive data in browser console

🎯 Roadmap

v1.0 (Current)

✅ GPA calculation and tracking
✅ Google Sign-In authentication
✅ Firebase cloud sync
✅ Analytics dashboard
✅ Dark/light mode

v1.1 (Planned)

📋 Advanced analytics charts
📊 GPA prediction tool
🎯 Goal setting and tracking
📤 Export to PDF
🔔 Grade milestone notifications

v2.0 (Future)

📱 Mobile app (React Native)
🌐 Multi-language support
🔄 Real-time collaboration
📚 Course recommendations
🎓 University profile integration

💡 How to Get Started Contributing

New to Open Source? No problem! Here's how to start:

Pick an Issue
- Look for "good first issue" label
- Comment: "I'd like to work on this"
- We'll provide guidance!

Set Up Locally

git clone https://github.com/your-username/GPA-Calculator.git
cd GPA-Calculator
npm install
npm run dev

Make Changes
- Edit files
- Test locally
- Make sure it works!
Submit Pull Request
- Describe what you changed
- Reference the issue number
- We'll review and merge! 🎉

Questions? Open an issue or email us. We're here to help!

🙌 Acknowledgments

Built with ❤️ using Vite
Authentication powered by Firebase
Sign-In by Google Identity
Inspired by the academic community

📊 Project Stats

📝 Recent Updates

Feb 27, 2026 - Google Sign-In integration complete 🎉
Feb 25, 2026 - Firebase authentication setup
Feb 20, 2026 - Project initialization with Vite

Star ⭐ us on GitHub to stay updated!

Made with 💜 by the GPA Calculator Community

⬆ back to top

Name		Name	Last commit message	Last commit date
Latest commit History 16 Commits
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
DEPLOYMENT_CHECKLIST.md		DEPLOYMENT_CHECKLIST.md
FIREBASE_SETUP.md		FIREBASE_SETUP.md
GOOGLE_LOGIN_SETUP.md		GOOGLE_LOGIN_SETUP.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
VERCEL_DEPLOYMENT.md		VERCEL_DEPLOYMENT.md
dashboard.html		dashboard.html
database.rules.json		database.rules.json
firebase.json		firebase.json
index.html		index.html
login.html		login.html
package.json		package.json
vercel.json		vercel.json
vite.config.js		vite.config.js

Folders and files

Latest commit

History

Repository files navigation

📚 GPA Calculator

✨ Features

Core Functionality

User Experience

Data Management

🚀 Quick Start

Prerequisites

Installation

🔒 Security & Configuration

Environment Variables

Deployment

📖 Setup Guide

Firebase Configuration

🛠️ Development

Available Commands

Project Structure

Technology Stack

🤝 Contributing

How to Contribute

Contribution Guidelines

Code Style

📋 Feature Requests & Bug Reports

Report a Bug

Request a Feature

👥 Collaborators

Wanted: Developers

Wanted: Designers

Wanted: Documentation

Areas for Improvement

📞 Get in Touch

📜 License

What You Can Do

What You Must Do

🔐 Security

Reporting Security Issues

Security Best Practices

🎯 Roadmap

v1.0 (Current)

v1.1 (Planned)

v2.0 (Future)

💡 How to Get Started Contributing

🙌 Acknowledgments

📊 Project Stats

📝 Recent Updates

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages