Skip to content

Commit bd85fe7

Browse files
Copilotrafiqul4
andcommitted
Update nsu-ekyc project documentation
Co-authored-by: rafiqul4 <124497017+rafiqul4@users.noreply.github.com>
1 parent f56579c commit bd85fe7

2 files changed

Lines changed: 129 additions & 27 deletions

File tree

docs/projects/nsu-ekyc.md

Lines changed: 129 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,143 @@
1-
# nsu_ekyc
1+
# NSU eKYC System
2+
23
## Overview
34

4-
Laravel Project
5+
A Laravel-based electronic Know Your Customer (eKYC) system developed for North South University. This application streamlines the customer verification process through digital means, enabling efficient identity verification and document management.
6+
7+
The system provides a secure, user-friendly platform for collecting, verifying, and managing customer identification information in compliance with regulatory requirements.
8+
9+
## ✨ Key Features
510

6-
<p align="center">
7-
<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
8-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
11+
- **Digital Identity Verification:** Electronic KYC process for efficient customer onboarding
12+
- **Document Management:** Upload, store, and verify customer identification documents
13+
- **Secure Data Storage:** Encrypted storage of sensitive personal information
14+
- **Verification Workflow:** Multi-step verification process for compliance
15+
- **Admin Dashboard:** Comprehensive management interface for KYC operations
16+
- **Audit Trail:** Complete logging of all verification activities
17+
- **Compliance Ready:** Built to meet regulatory KYC requirements
918

10-
## Code & Repository
19+
## 🏗️ Technology Stack
20+
21+
### Primary Technologies
22+
- **Framework:** Laravel Framework
23+
- **Language:** PHP 7.4+
24+
- **Frontend:** HTML, Blade Templates
25+
- **Database:** MySQL
26+
- **Architecture:** REST API
1127

28+
### Additional Technologies
29+
- Laravel authentication for secure access
30+
- File storage system for documents
31+
- Shell scripts for deployment
32+
33+
## 📊 Project Information
34+
35+
### Repository Details
1236
- **GitHub:** https://github.com/syed-reza98/nsu_ekyc
1337
- **Primary Language:** PHP
14-
- **Languages:** PHP (53.8%), HTML (29.3%), Blade (16.4%), Shell (0.6%)
15-
- **Last Updated:** 09/11/2021
38+
- **Languages Breakdown:** PHP (53.8%), HTML (29.3%), Blade (16.4%), Shell (0.6%)
1639
- **Repository Size:** ~3MB
40+
- **Last Updated:** 09/11/2021
1741

18-
## Architecture & Tech Stack
42+
### Project Status
43+
- **Status:** 🟢 Active
44+
- **Visibility:** 🌐 Public
1945

20-
- **Technology Stack:** Laravel Framework
21-
- **Architecture:** REST API
46+
## 🏷️ Categories & Tags
2247

23-
## Project Status
48+
**Primary Category:** Web Development / Enterprise Software
2449

25-
- **Status:** ✅ Active
26-
- **Visibility:** 🌐 Public
50+
**Tags:** `laravel` `php` `ekyc` `identity-verification` `kyc` `document-management` `compliance` `fintech`
51+
52+
## 🚀 Getting Started
53+
54+
### Prerequisites
55+
- PHP 7.4 or higher
56+
- Composer
57+
- MySQL 5.7+
58+
- Web server (Apache/Nginx)
59+
60+
### Installation
61+
62+
1. **Clone the repository**
63+
```bash
64+
git clone https://github.com/syed-reza98/nsu_ekyc.git
65+
cd nsu_ekyc
66+
```
67+
68+
2. **Install dependencies**
69+
```bash
70+
composer install
71+
```
72+
73+
3. **Set up environment**
74+
```bash
75+
cp .env.example .env
76+
# Configure database and file storage settings
77+
```
78+
79+
4. **Generate application key**
80+
```bash
81+
php artisan key:generate
82+
```
83+
84+
5. **Run migrations**
85+
```bash
86+
php artisan migrate --seed
87+
```
88+
89+
6. **Set up storage**
90+
```bash
91+
php artisan storage:link
92+
```
93+
94+
7. **Start development server**
95+
```bash
96+
php artisan serve
97+
```
98+
99+
## 🏛️ Architecture
100+
101+
**Architecture Pattern:** MVC with REST API
102+
103+
**Key Architectural Decisions:**
104+
- Laravel MVC architecture for clean code organization
105+
- RESTful API endpoints for potential mobile integration
106+
- Secure file storage for sensitive documents
107+
- Role-based access control for different user types
108+
- Audit logging for compliance requirements
109+
110+
## 🤝 Contributing
111+
112+
Contributions are welcome! Please follow these steps:
113+
114+
1. Fork the repository
115+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
116+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
117+
4. Push to the branch (`git push origin feature/amazing-feature`)
118+
5. Open a Pull Request
119+
120+
For detailed contribution guidelines, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
121+
122+
## 📝 Additional Information
123+
124+
### Development Notes
125+
- Ensure compliance with data protection regulations
126+
- Implement proper encryption for sensitive data
127+
- Regular security audits recommended
128+
- Follow KYC best practices and regulatory requirements
129+
130+
### Security Considerations
131+
- All personal data must be encrypted at rest
132+
- Implement proper access controls
133+
- Regular security updates required
134+
- Comply with data privacy regulations (GDPR, etc.)
135+
136+
### Credits & Attribution
137+
- **Lead Developer:** Syed Salman Reza
138+
- **Institution:** North South University
139+
- Built with Laravel Framework
27140

28-
## Development Notes
141+
---
29142

30-
- For detailed setup instructions, refer to the [repository README](https://github.com/syed-reza98/nsu_ekyc#readme)
31-
- Contributing guidelines and project documentation available in the repository
143+
**For detailed setup instructions and documentation, refer to the [repository README](https://github.com/syed-reza98/nsu_ekyc#readme).**

package-lock.json

Lines changed: 0 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)