material_estudos_ifal

What the study repository contains

The repository is a collaborative content project for the Bachelor of Information Systems course at the Instituto Federal de Alagoas, written in Portuguese as Material de Estudo IFAL. The README describes an interactive web application that organizes study material for all subjects in the BSI course. Each subject has its own page with content organized by topic, derived from materials provided by professors. The application also offers a static quiz with fixed multiple choice questions and feedback, plus a quiz powered by the Google Gemini API that generates questions in real time. The interface is described as premium, with dark mode, animations, and a modern design. Beyond the app itself, the repository contains a development framework built from AI agents. The .agent directory holds an orchestrator and specialists for academic content, frontend development, and quality assurance. The .skills directory provides reusable instructions for simplifying code, reviewing the user interface, creating content, building quizzes, and reviewing pull requests. The .docs directory holds functional specifications and usage rules, and the src tree separates components, content, data, hooks, and pages. A scripts directory includes a classroom collector that downloads materials from Google Classroom. The project is presented as educational use, with content derived from materials made available by IFAL professors.

Running the application locally

To run the application on a local machine, the README gives a short command sequence. The first step clones the repository with git clone pointing at the material_estudos_ifal GitHub URL, then changes into the project directory with cd. The second step installs dependencies with npm install. The third step starts the development server with npm run dev. After that, the application is available at the local address http://localhost:5173. These commands assume that Node.js and npm are already present on the machine. The project badges state React 19, TypeScript 5, Tailwind CSS 4, and Vite 6, so a recent Node.js toolchain is expected. The README does not list a specific Node version, but the Vite 6 requirement implies a current LTS release. The local server provides hot reloading, which lets a contributor edit content or components and see changes without restarting. The same repository also contains a Google Classroom collector under scripts/classroom that can list turmas and download attachments, which is useful for pulling professor materials into the project before they are summarized and cited. Running locally is the recommended way to preview edits before opening a pull request, and the dev server mirrors the production build closely enough for content work.

Publishing to GitHub Pages

The project is already configured for GitHub Pages through GitHub Actions, so publishing does not require manual uploads. The README walks through four steps in the repository Settings. First, open Settings and go to Pages. Second, under Build and deployment, select GitHub Actions. Third, merge a pull request into the main branch or run the workflow manually. Fourth, the Deploy to GitHub Pages workflow builds the dist directory and publishes the site. Because the repository is published at the GitHub Pages address https://periclesanfe.github.io/material_estudos_ifal/, the Vite configuration uses base equal to slash material_estudos_ifal slash in production. The README notes that the project also includes SPA fallback so that routes such as slash materia slash comportamento-organizacional work when opened or reloaded directly. This matters because a single page application would otherwise return a 404 on deep links. The automated deploy keeps the live site in step with the main branch, and contributors only need to land their changes through the normal pull request flow. The combination of Vite, GitHub Actions, and the configured base path means the student built study site can be hosted for free without a separate server. The workflow file that performs the deploy is part of the repository, so the entire release process is visible in the project's GitHub Actions configuration and can be audited by any contributor.

Editorial conclusion

The project is built with React 19, TypeScript 5, Tailwind CSS 4, and Vite 6, and it is deployed to GitHub Pages through GitHub Actions. The curriculum data covers 64 subjects across eight periods of the BSI course.