Skip to content

Latest commit

 

History

116 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FIAE-Exam-Part-1-Learning (Frontend)

Interactive learning platform for preparing for the AP1 exam (IT professions).

Live Website: https://seanconroy-dev.github.io/FIAE-Exam-Part-1-Learning


Preview

App Preview

Screenshot

Main Page


Architecture (current)

This repository contains the frontend (Astro).

Content (Markdown cards + assets) is stored separately and is served to the frontend via a backend API.

  • Frontend (this repo): seanconroy-dev/FIAE-Exam-Part-1-Learning
  • Content repo: seanconroy-dev/FIAE-Exam-Part-1-Content
  • Backend API: configured via PUBLIC_API_BASE and consumed at:
    • GET /api/cards/markdown

Note: The folder structure + frontmatter rules below describe the content format expected by the backend/content repo.


Local Development

From the site/ directory:

npm install
npm run dev

Configure the backend base URL:

# site/.env
PUBLIC_API_BASE=https://fiae-exam-part-1-backend-production.up.railway.app

Content Format (Frontmatter + Conventions)

Each learning card uses a fixed YAML frontmatter. This schema is stable and must not be changed after publication.

# Identity (stable; never change after publishing)
id: ap1-0000
slug: ""

# Display
title: ""

# Classification / navigation (machine-side)
module: ""          # must match one top-level folder name exactly
topics: []          # e.g. ["Netzwerke", "OSI"]
tags: []            # e.g. ["exam-relevant", "definition"]

# Flashcard payload
card:
  type: basic       # basic | multi | steps | definition | comparison
  question: ""
  answer: ""
  examples: []      # optional

# Lifecycle
status: draft       # draft | published | deprecated
created: "2026-03-10"
updated: "2026-03-10"

The actual learning content follows after the frontmatter.


File Name Convention

Files follow a strict naming pattern:

<module-folder>/ap1-0001-<slug>.md

Example:

Beurteilen marktgängiger IT-Systeme und Lösungen/ap1-0071-usv-aufgaben.md

Rules:

  • The ID in the filename must match the ID in the frontmatter
  • The slug should be short, unique, and lowercase
  • Words must be separated by hyphens

Note Style Guidelines

The repository has evolved over time.

  • Frontmatter schema is immutable
  • Existing notes must not be reformatted, except to fix factual errors
  • Notes before ap1-0072 may use an older format
  • New notes must follow the current structure

Structure of New Notes

New notes should follow this structure:

## Overview
## Core Explanation
## Practical Example
## Exam Relevance (AP1)
### Typical Exam Questions
### Answers to Typical Questions
## Key Takeaway

This structure supports:

  • fast revision
  • conceptual understanding
  • preparation for typical exam questions

Flashcard Rules

The flashcard in the frontmatter is used for active recall (e.g., Anki).

Therefore:

  • card.answer must be short and exam-ready
  • longer explanations belong only in the note body
  • examples can optionally be added in examples

Goal:

Flashcard = fast recall  
Note content = understanding and context

Style Guidelines

When writing new notes:

  • Language: German
  • Style: precise, neutral, exam-oriented
  • No conversational tone
  • Prefer short paragraphs and bullet points
  • Use tables for comparisons or classifications
  • Use Mermaid diagrams for processes and relationships

Goal: a clear, structured, and repeatable learning system for the AP1 exam

About

Interactive FIAE Exam part 1 learning platform with structured flashcards and explanations for IT exam preparation.

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Contributors

Languages