Skip to content

yonatanmgr/pi-factor

Repository files navigation

📊 Pi-Factor

Pi-Factor (TAU-Factor 2) is a web application designed to help TAU students track course grades accross semesters. The application is built with React and Next.js, and is optimized for both mobile and desktop views.

Features

  • Course Management: Add, remove, and track courses.
  • Grade Tracking: View grades for selected courses.
  • Language Support: Switch between Hebrew, Arabic, and English.
  • Dark Mode: Toggle between light and dark themes.
  • Responsive Design: Optimized for both mobile and desktop views.

Technologies Used

  • TypeScript
  • JavaScript
  • React
  • Next.js
  • Tailwind CSS
  • shadcn/ui
  • Recharts
  • Zustand
  • Vercel Analytics
  • Vercel Speed Insights

Getting Started

Prerequisites

  • Node.js
  • pnpm

Installation

  1. Clone the repository:
    git clone https://github.com/yonatanmgr/pi-factor.git
  2. Navigate to the project directory:
    cd pi-factor
  3. Install the dependencies:
    pnpm install

Running the Application

To start the development server, run:

next dev

Open your browser and navigate to http://localhost:3000 to view the application.

Building for Production

To build the application for production, run:

next build

This will create an optimized build in the out directory.

Deployment

The application is configured to be deployed on Vercel. Follow the Vercel documentation for deployment instructions.

Project Structure

  • app/page.tsx: Main page component.
  • app/layout.tsx: Root layout component.
  • lib/utils.ts: Utility functions.
  • public/: Static assets.
  • styles/: Global styles.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

Acknowledgements

Contact

For any inquiries, please contact the project maintainer at yonatanmgr.

About

A web application designed to help TAU students track course grades accross semesters.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors