System Requirements Document

Introduction

This document outlines the system requirements for the development of "SprawdzFirme," a modern web application/PWA designed to help users in Poland gather information about companies or contractors before engaging in business transactions. The application is intended to be a TrustTech/ConsumerTech product, providing a comprehensive platform for users to verify companies, read reviews, and analyze contracts using AI.

System Overview

SprawdzFirme is a full-stack application that includes a frontend, backend, database, user authentication, company profiles, search functionality, review and reporting systems, moderation, admin and business owner panels, contract analysis via AI, PWA capabilities, SEO, and security features. The application is designed as an MVP with scalable architecture for future commercial expansion.

Functional Requirements

User Stories

1. As a user, I want to search for a company using NIP, company name, REGON, KRS, or phone number to find relevant information.
2. As a user, I want to view available information about a company, including registration details and reviews.
3. As a user, I want to read reviews and see reports related to a company's business practices.
4. As a user, I want to see a company's response to reports and reviews.
5. As a user, I want to check a company's registration information.
6. As a user, I want to go through a checklist before making a payment to ensure all necessary precautions are taken.
7. As a user, I want to analyze a contract using AI to identify potential risks and missing elements.
8. As a user, I want to add my own review about a company.
9. As a user, I want to report a problem with a company.
10. As a user, I want to see a company's profile with detailed information and status updates.
11. As a business owner, I want to manage my company profile and respond to reviews and reports.
12. As a moderator, I want to review and manage user-generated content for compliance and accuracy.
13. As an admin, I want to oversee the platform's operations, including user activity and content moderation.
14. As a user, I want to receive notifications about changes in the status of my reports or reviews.
15. As a user, I want to use the application on mobile, tablet, and desktop devices with a responsive design.
16. As a user, I want to install the application as a PWA for offline access.
17. As a user, I want to ensure my data is secure and my privacy is protected.
18. As a user, I want to access a help center for guidance on using the platform.
19. As a user, I want to understand how the Information Index is calculated and what it represents.
20. As a user, I want to integrate with external data sources for comprehensive company information.
21. As a user, I want to access FAQs where applicable to get quick answers to common questions.
22. As a user, I want the application to be optimized for search engines to easily find relevant company information.
23. As a user, I want to see Polish legal/document placeholders to understand the legal context of the information provided.
24. As a user, I want to know the estimated reading time for articles to manage my time effectively.
25. As a user, I want FAQs to be included where they make sense to enhance my understanding of the content.

User Personas

1. General User: Individuals seeking to verify companies before engaging in business transactions.
2. Business Owner: Company representatives managing their profiles and responding to user feedback.
3. Moderator: Personnel responsible for content moderation and ensuring compliance with platform guidelines.
4. Administrator: Platform overseers managing overall operations, user roles, and system settings.

Core User Flows

Flow 1: Company Verification

1. User enters the homepage.
2. User inputs company details in the search bar.
3. User views search results and selects a company profile.
4. User reviews company information, opinions, and reports.
5. User decides to check further before making a payment.

Flow 2: Contract Analysis

1. User accesses the contract analysis tool.
2. User uploads a contract document.
3. AI analyzes the document and generates a report.
4. User reviews the report for key points and potential risks.

Flow 3: Problem Reporting

1. User selects the option to report a problem.
2. User fills out the problem report form and uploads supporting documents.
3. Moderation team reviews the report.
4. User receives a CASE-ID and can track the status of the report.

Visuals Colors and Theme

• Style: Modern, minimalist, with ample white space and clear typography.
• Colors: Neutral and professional tones with high contrast for readability.
• Design: Rounded cards, subtle shadows, and clear CTAs.

Signature Design Concept

• Mobile-first design: Prioritize mobile usability with a clean and intuitive interface.
• Startup aesthetic: Reflect a modern Polish tech startup rather than a bureaucratic portal.

Interaction Model & Motion Direction

• Animations: Delicate animations to enhance user experience without causing distraction.
• Navigation: Bottom navigation for mobile and top navigation for desktop.

Non-Functional Requirements

• Performance: Fast loading times, optimized images, and efficient code.
• Accessibility: Compliance with WCAG 2.2 AA standards.
• Security: Robust security measures including server-side validation and secure data handling.

Tech Stack

• Frontend: React, TypeScript, Tailwind CSS.
• Backend: Node.js with server-side runtime.
• Database: Firebase Firestore.
• Authentication: Firebase Authentication.
• AI: Gemini for contract analysis and moderation support.

Assumptions and Constraints

• The application will initially target users in Poland.
• Legal documents and privacy policies require verification by a Polish lawyer before production deployment.
• The application will not store sensitive user data offline.

Glossary

• NIP: Tax Identification Number in Poland.
• REGON: National Official Business Register Number.
• KRS: National Court Register.
• PWA: Progressive Web Application.
• AI: Artificial Intelligence.
• MVP: Minimum Viable Product.
• WCAG: Web Content Accessibility Guidelines.