StockFellow is a modern financial solution designed to streamline and secure traditional
stokvel savings groups. By leveraging automation, robust security, and open-source
technologies, the platform addresses the core challenges of trust, efficiency, and compliance
while introducing innovative features to enhance user experience.
View Project Board
·
View Documentation
Table of Contents
| Demo | Video | Presentation |
|---|---|---|
| Demo 1 | Video | Presentation |
| Demo 2 | Video | Presentation |
| Demo 3 | Video | Presentation |
| Demo 4 | Video | Presentation |
| Final Video | Video | |
| App Link | APK | |
| Mock PDF Bank Statements | PDFs |
| Link | Description |
|---|---|
| Software Requirements Specification | Project Requirements |
| Architectural Specification | Architectural Patterns, Strategies and Functional Requirements |
| Coding Standard | Coding best practices to follow and programming guidelines |
| Testing Policy | Testing strategy and mthods for testing the system |
| Deployment Model | Deployment architecture and infrastructure specifications |
| User Manual | Step by step documentation on how to use the app |
| Technical Installation Manual | Guide to install and run project |
| Research Document | Research done for the project |
- Demo 1
- Register and Login
- Create Stokvel
- View Stokvel Groups
- Demo 2
- Transaction Service
- Group Service
- Notification Service
- Mock Payment Service
- Demo 3
- Transaction Service
- System Tier And Group Management
- Notification Service
- PayStack Integration
- MFA Service
- Demo 4
See the open issues for a full list of proposed features (and known issues).
This project makes use of the Git Flow branching strategy with the following branch types:
-
main:
- Production-ready branch containing stable, released code
- Protected branch - direct commits are not allowed
-
dev:
- Integration branch for ongoing development
- Serves as the base branch for feature branches
-
feature/[feature-name]:
- Created from the dev branch
- Naming convention:
feature/add-payment-gateway,feature/user-dashboard
-
release/[version]:
- Created from dev when preparing a new release
- Naming convention:
release/v1.0.0,release/v1.2.3
-
hotfix/[fix-name]:
- Created from main to fix critical production issues
- Naming convention:
hotfix/fix-login-security,hotfix/payment-calculation
The repository follows a monorepo structure using npm workspaces to encapsulate separate components and their related package.json and lock files. This structure:
- Keeps related code together while maintaining separation of concerns
- Enables sharing of common code and dependencies
- Simplifies dependency management across the entire project
- Facilitates coordinated versioning and releases
- Supports parallel development across different app components
Our planned workspace organization:
stockfellow/
├── docs/ # Project documentation
├── packages/ # Shared packages
├── services/ # Backend services
│ └── user-service/
├── apps/ # Frontend applications
│ ├── web-app/
│ └── mobile-app/
├── scripts/ # Build/dev scripts
├── package.json # Root package.json + workspace config
└── README.md # Project overview
Dev Opps: devopps@gmail.com
Project Link: https://github.com/COS301-SE-2025/StockFellow




