Skip to content

PUP-BSIT/project-errawrs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

492 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💳 Team Errawrs Bank Application

🏦 StackOverCash

A lightweight banking application designed for simple and secure financial transactions. This project features robust authentication, role-based access, and a smooth user experience.

📚 Table of Contents


🚀 Features

  • 🏗️ Modular Monolith Structure
  • 🔐 User Authentication – Secure login system for all users.
  • 🔁 Fund Transfers
    • Internal (within the system)
    • External (to other systems)
  • 🔑 OTP-Based Multi-Factor Authentication – Adds an extra layer of security.
  • 👥 Role-Based Access Control
    • Admin
    • Teller
    • Account Holder

🌐 Live Demo

Visit the application here:
🔗 Errawrs Web Host: StackOverCash


🧪 Demo Account Credentials

Use the following credentials to explore the different roles in the application:

👤 User Account

  • Username: simonejakereyes
  • Password: DNSZtebjOFlaTdgy

🧾 Teller Account

  • Username: T000006
  • Password: 123456789

🛠️ Admin Account

  • Username: admin
  • Password: Admin@123

⚠️ Note: These demo accounts are for testing purposes only. Please do not store sensitive information.

📹 Video Recording of our Presentation

🔗 https://youtu.be/YT7I0XK5CX4?si=BuJGyQo68l6O63Xt


🛠️ Tech Stack

  • Backend: PHP
  • Frontend: HTML / CSS / JS
  • Database: MySQL
  • Hosting: AWS EC2 (Ubuntu)
  • Server: NGINX + PHP-FPM
  • CI/CD: GitHub Actions (SSH Deploy)
  • SMS Gateway:

📂 Project Folder Structure

📂Root

  • ├── 📂/public
  • │ ├── 📂/admin
  • │ │ ├── 📂/css
  • │ │ ├── 📂/js
  • │ │ └── 📄login_admin.html
  • │ ├── 📂/teller
  • │ │ ├── 📂/css
  • │ │ ├── 📂/js
  • │ │ └── 📄login_teller.html
  • │ ├── 📂/user
  • │ │ ├── 📂/css
  • │ │ ├── 📂/js
  • │ │ └── 📄login_account_holder.html
  • │ ├── 📂/assets
  • │ │ ├── 📂/images
  • │ │ ├── 📂/fonts
  • │ │ └── 📂/icons
  • │ └── 📄index.html
  • ├── 📂/src
  • │ ├── 📂/api
  • │ │ ├── 📂/admin
  • │ │ ├── 📂/auth
  • │ │ ├── 📂/teller
  • │ │ └── 📂/user
  • │ ├── 📂/config
  • │ │ ├── 📄database.php
  • │ │ └── 📄config.php
  • │ ├── 📂/auth
  • │ │ ├── 📄auth.php
  • │ │ └── 📄session.php
  • │ └── 📂/logs
  • └── 📄README.md

🗂️ Git Workflow Guidelines

🌿 Branch Types and Naming Conventions

Branch Type Description Naming Convention
main Production branch main
staging ready to deploy branch staging
dev Main dev branch dev
feature New feature development feature/
bugfix Fixes identified bugs bugfix/
hotfix Quick fix for prod issue hotfix/
docs Document related branch docs/

🔧 Branching Guidelines

  • ✅ Create a branch from dev for any feature, bugfix, or enhancement.
  • ✅ Use descriptive branch names (e.g., feature/user-authentication).
  • ✅ Commit often with meaningful messages.
  • ✅ Keep branches focused; one purpose per branch.

🔀 Merging Guidelines

  • 🔁 Use Pull Requests (PRs) to merge into dev or main.
  • ✅ Ensure all PRs are reviewed before merging.
  • ✅ Test the feature before merging to dev.
  • 🚫 Never push directly to main.

📜 General Coding Guidelines

💬 Comments & Documentation

  • Use comments only when necessary.
  • Document complex logic or non-obvious implementation.

📄 Function & Module Docs

  • Add short descriptions to explain the purpose of each module or method.

💥 Error Handling

  • Use try/catch blocks
  • Show clear and meaningful error messages

🔗 Click here to view full guidelines


🧑‍💻 Contributors

Name Role
Gerald Mamasalanang Project Manager/Developer
Daniel Victorioso Tech Lead/Developer
Simone Jake Reyes UI/UX/Developer
Ivan Delumen Tester/Developer

📝 Developer Documentation

About

project-errawrs created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors