Skip to content

CreatorSaWiX/apunts-pro2

Repository files navigation

Apunts PRO2 / M1 / M2

Platform to share interactive notes, problem solutions from Jutge.org, and academic resources for Programming 2 (PRO2) and Mathematics (M1/M2) at UPC-FIB.

Apunts Platform Screenshot

Tech stack

React Vite Tailwind CSS TypeScript Firebase Vercel

  • Core: React 19, TypeScript, Vite, PWA
  • Styles & UI: Tailwind CSS v4, Framer Motion, Lucide React, React Three Fiber (Three JS)
  • Routes & states: React Router v7, Context API nativa
  • Backend & data: Firebase (Auth, Firestore)
  • Content management (Markdown): @content-collections (with Zod), React Markdown, Unifiedjs (Remark/Rehype), KaTeX, PrismJS / CodeMirror
  • External services: Vercel Serverless Functions (Proxy for Jutge.org for scraping)

Structure (src/)

  • components/: Encapsulated UI, featuring simulators integrable in MD (OOPPlayer, AlgoPlayer, GraphVisualizer).
  • content/: Static database in Markdown format (/notes/pro2/, /notes/m1/). Closely compiled by Content Collections.
  • contexts/: Global states (Auth, Subject).
  • lib/: Connections to services and pure logic (firebase.ts, simulations).
  • markdown/: Advanced rendering tool (Custom directives in Markdown).
  • pages/: Views assigned to the Router.

Installation and development

  1. Clone the repository

    git clone https://github.com/CreatorSaWiX/apunts-pro2.git
    cd apunts-pro2
  2. Install dependencies

    npm install
  3. Configuration (Optional) Create a .env.local file with your Firebase configuration and optional Jutge credentials.

  4. Run in local

    npm run dev

Contributing

We are an open community! If you want to add notes or improve the platform:

  1. Check that the application compiles correctly (npm run build).
  2. Follow strict TypeScript standards (avoid any).
  3. Open a Pull Request with a clear description of the change.

License: MIT | Maintained by @CreatorSaWiX

About

Interactive educational platform for UPC-FIB students featuring real-time mathematical visualizers and algorithmic simulations built with React 19, Three.js, and Mafs.

Topics

Resources

License

Stars

Watchers

Forks

Contributors