Bangsluke Documentation
website·Indexed 31 days ago
https://bangsluke-documentation.netlify.app/A comprehensive knowledge base covering the Software Development Life Cycle (SDLC), Agile methodologies, and Product Management. It includes guides on Scrum, SRE principles, product discovery, and release strategies, alongside technical documentation for specific projects like the Dorkinians Website and Acre Software Task, as well as general guides for Git, NPM, and PowerShell.
What's inside Bangsluke Documentation
- The Club Info section of the Dorkinians website serves as a comprehensive hub for club-related data. It is divided into four primary areas: Club Information (history, milestones, location), League Information (standings and results), Club Captains and Awards, and Useful Links to external resources.
Overview of the Dorkinians Website Settings page
The Settings page provides PWA installation options, a comprehensive navigation tree for all app sections, database status information, and general app details. It is accessible via the cog (settings) icon located in the header of any page within the app.Overview of the Dorkinians Website PWA
The Dorkinians Website is a mobile-first Progressive Web App (PWA) designed to provide comprehensive statistics and information about Dorkinians Football Club. Key features include a chatbot interface for querying statistics, detailed player/team/club metrics, Team of the Week (TOTW) displays, and club information.Overview of the Dorkinians Website Home page
The Home page serves as the main entry point for the Dorkinians Website app. It features a chatbot interface that allows users to query player statistics, team performance, and club information using natural language. To enable personalized queries (using pronouns like "I", "me", or "my"), users must first select a player. However, users can still query other players by using their full names regardless of the current selection.Overview of the Dorkinians Player Profile page
The Player Profile page provides a focused summary of a single player's highlights. The page is organized in a top-to-bottom sequence consisting of three core sections: Season Wrapped, Headline Stats, and Achievement Badges. It is designed for quick scanning with links available for deeper data exploration.Understand the core risks addressed by Product Discovery
Product discovery is the process of uncovering unmet customer needs and validating solutions before committing engineering resources. Its primary purpose is to collect evidence to mitigate four critical risks:
- Value Risk: Will the customer buy or use this? (Validates if the problem is worth solving).
- Usability Risk: Can the user figure out how to use it? (Tests the approach's usability).
- Feasibility Risk: Can we build it? (Confirms technical feasibility and scope).
- Business Viability Risk: Does this solution work for our business? (Ensures alignment with strategy and viability).
Additionally, teams should consider Ethics Risk: "Should we build it?" to avoid harming users or the environment.
Organize React project folder structure
A recommended folder structure for React projects, based on the Bulletproof React architecture, is as follows:src |-- /assets # Static files (images, fonts, etc.) |-- /components # Shared components used across the app |-- /config # Global configuration and env variables | -- .env # Environment variables |-- /data # Stored data used across the application |-- /features # Feature-based modules |-- /hooks # Shared hooks |-- /lib # Preconfigured library re-exports |-- /providers # Application providers |-- /routes # Routes configuration (omit for Next.js) |-- /stores # Global state stores |-- /test # Test utilities and mock server |-- /types # Base types |-- /utils # Shared utility functionsImplement Lender Dashboard Overview KPIs
The Lender Dashboard provides lenders with a comparative view of their performance against the market. Key metrics include conversion speed, market share, and commercial outcomes.- Conversion Velocity Rank: Position among lenders by average days-to-offer (
firstSubmittedDatetocompletionDate). Minimum volume eligibility: >= 5 cases. - Your Cases: Total case count and completion market share (Lender completed cases / Market completed cases).
- Total Net Revenue: Sum of
netCaseRevenuevalues and Total loan value. - Avg Loan Size: Average loan size for submitted business.
- Completion Rate: Lender completed cases / Lender total cases, compared to market equivalent.
- Avg Days to Offer: Average difference between
firstSubmittedDateandfirstOfferDate(requires both dates to be present).
- Conversion Velocity Rank: Position among lenders by average days-to-offer (
Choose a mobile application architecture
Depending on the project requirements, consider the following frameworks for mobile development:
- React Native: For building native apps using React.
- Expo: A platform and workflow for React Native development.
- Capacitor.js: For building cross-platform apps using web technologies.
Acre Software Task project overview and technical stack
The Acre Software Task is a Single Page Application (SPA) designed to visualize mortgage metrics and insights. It features two distinct dashboards: an Internal Dashboard for Acre employees to monitor global lender activity, and a Lender Dashboard for external partners to track their own performance against anonymized market baselines.
Technical Stack & Implementation:
- Architecture: React + TypeScript SPA.
- Data Handling: CSV data is parsed client-side and mapped into typed domain objects.
- Scope: Designed for desktop viewports; excludes routing, authentication, and global navigation (header/footer/sidebar) as it is intended to be embedded within a larger application.
Select a data fetching library for React
Depending on the API type and architecture, use the following libraries:
- TanStack Query (React Query): Versatile for both REST and GraphQL APIs. Install via
yarn add @tanstack/react-query. - Apollo Client: Specifically for GraphQL APIs. Install via
yarn add @apollo/client. - RTK Query: Use if the project is already utilizing Redux.
- tRPC: Ideal when both frontend and backend are TypeScript and controlled by the same team; can be combined with TanStack Query.
- TanStack Query (React Query): Versatile for both REST and GraphQL APIs. Install via
Understand the standard phases of the Software Development Life Cycle (SDLC)
The SDLC is a structured methodology used to design, develop, and test high-quality software. It typically consists of eight sequential phases where each phase relies on the deliverables of the previous one:
- Planning and Design: Gathering requirements and architecting the solution.
- Code: The active development phase where software is written.
- Verify: Testing to ensure the software is bug-free and solves the intended problem.
- Integrate: Combining modules and managing dependencies.
- Release: Packaging and preparing software for delivery.
- Deploy: Moving software into production environments.
- Operate: Running the software in a live environment.
- Monitor: Observing system health and user behavior.