Supplier Rating Software - Frontend

This is the dedicated web frontend for the Supplier Rating Software, a specialised application designed to evaluate suppliers at a material science institution.

As a modern user interface, it communicates with the backend to display data from the openBIS data management system in a user-friendly way. It hides technical details and offers intuitive workflows for order rating and supplier evaluation.

---

1. Key Features

🚀 Core Functionality

• Supplier & Order Management: Comprehensive list views and detail pages for managing supplier and order information.
• Interactive Rating: User-friendly modals and forms for entering ratings (Quality, Cost, Reliability, Availability), which are sent directly to the backend for calculation.
• Responsive Design: Optimized display for various screen sizes thanks to Bootstrap 5 integration.

🛡️ Technical Highlights

• Modern Tech Stack: Built on Angular 21, utilizing the latest features like Standalone Components and Signals.
• Automated API Integration: The API client is automatically generated from the backend specification (openapi.yaml) using the OpenAPI Generator, guaranteeing type safety.
• Dockerized Deployment: Production-ready Docker image that serves the application using Nginx.

---

2. Technologies Used

• Framework: Angular 21
• Language: TypeScript 5.9
• Styling: SCSS, Bootstrap 5.3, Bootstrap Icons
• Build Tool: Angular CLI
• API Client Generation: OpenAPI Generator CLI
• Containerization: Docker & Nginx

---

3. Code Organization

The source code follows a modular structure focused on features and reusability.

src/app
├── components      // Reusable UI components (Buttons, Modals, Toasts)
├── layout          // Layout wrappers (e.g., MainLayout with Sidebar/Navbar)
├── models          // TypeScript Interfaces and DTOs
├── openapi-gen     // Automatically generated API client (DO NOT edit manually)
├── openapi         // OpenAPI specification (Source for generator)
├── pages           // Main views accessed via the router
│   ├── dashboard
│   ├── login
│   ├── orders
│   └── suppliers
├── services        // Application logic and state management
└── environments    // Configuration for Dev/Prod (API URLs, etc.)

4. Contributing

First off, thank you for considering contributing to the Supplier Rating Frontend! 🚀

We welcome everyone who wants to make this project better—whether you're fixing a bug, improving documentation, or proposing a cool new feature.

🤝 How can I contribute?

1. Found a Bug?

• Ensure the bug was not already reported by searching on GitHub under Issues.
• If not, open a new issue with a clear title and description.

2. Have a Feature Idea?

• Great! We love new features. Please open an issue first to discuss your idea. This ensures that your feature fits into the architectural vision and prevents you from doing unnecessary work.

3. Submit a Pull Request (PR)

• Fork the repository and create your branch from main.
• Code your changes. Use npm run lint:check and npm run prettier:check to maintain code style.
• Test your changes thoroughly.
• Submit the PR! We will review it as soon as possible.

📝 Coding Guidelines

To keep the codebase clean and maintainable, please keep the following in mind:

• Angular Best Practices: Use Standalone Components and strict typing.
• Commit Messages: We prefer Conventional Commits (e.g., feat: add supplier list, fix: login validation) to keep the history readable.

Thank you for your support! ❤️

5. License

This project is licensed under the MIT License - see the LICENSE file for details.