Files
ISA-Frontend/docs/tech-stack.md
Lorenz Hilpert 3c110efdfa 📚 Add state management and testing guidelines documentation
Introduced new documentation files for state management and testing guidelines to enhance developer understanding and best practices.

- 📚 **Docs**: Added state management guidelines with local and global state recommendations
- 📚 **Docs**: Created testing guidelines including unit testing requirements and best practices
- 📚 **Docs**: Updated project structure documentation for clarity
2025-03-31 11:52:17 +02:00

2.5 KiB

Tech Stack Documentation

Core Technologies

Frontend Framework

  • Angular (Latest Version)
    • Modern web framework for building scalable single-page applications
    • Leverages TypeScript for enhanced type safety and developer experience

State Management

  • NgRx
    • Redux-inspired state management for Angular applications
    • Provides predictable state container and powerful dev tools
    • Used for managing complex application state and side effects

Styling

  • Tailwind CSS
    • Utility-first CSS framework
    • Enables rapid UI development with pre-built classes
    • Highly customizable through configuration

Development Tools

Language

  • TypeScript
    • Strongly typed programming language
    • Provides enhanced IDE support and compile-time error checking
    • Used throughout the entire application

Runtime

  • Node.js
    • JavaScript runtime environment
    • Used for development server and build tools
    • Required for running npm scripts and development tools

Testing Framework

  • Jest

    • Primary testing framework
    • Used for unit and integration tests
    • Provides snapshot testing capabilities
  • Spectator

    • Angular testing utility library
    • Simplifies component testing
    • Reduces boilerplate in test files

UI Development

  • Storybook
    • UI component development environment
    • Enables isolated component development
    • Serves as living documentation for components

Utilities

  • date-fns
    • Modern JavaScript date utility library
    • Used for consistent date formatting and manipulation
    • Tree-shakeable to optimize bundle size

Development Environment Setup

  1. Required Software

    • Node.js (Latest LTS version)
    • npm (comes with Node.js)
    • Git
  2. IDE Recommendations

    • Visual Studio Code with following extensions:
      • Angular Language Service
      • ESLint
      • Prettier
      • Tailwind CSS IntelliSense
  3. Getting Started

    npm install          # Install dependencies
    npm run start       # Start development server
    npm run test        # Run tests
    npm run storybook   # Start Storybook