User Management System

Introduction

A full-stack application for managing user accounts with features like email sign-up, verification, authentication, role-based authorization, and CRUD operations.

Installation

1. Clone the repository:

git clone https://github.com/Beirun/user-management-system.git
cd user-management-system

2. Install dependencies:

cd backend
npm install

cd frontend
npm install

3. Start the backend server:

cd backend
npm run dev

4. Start the Vue app:

cd frontend
npm run dev

Usage

• Register a new account at /accounts/register.
• Verify your email using the link sent to your inbox.
• Log in at /accounts/login.

Testing

• Functional testing results: [Link to test cases]
• Security testing results: [Link to test cases]

Contributing

Follow the Git and GitHub workflow outlined in the project guidelines.

License MIT License

---

Best Practices

1. Commit Often: Make small, frequent commits with clear messages to track progress.
2. Use Descriptive Branch Names: Name branches based on their purpose.
3. Review Code Before Merging: Always review pull requests to ensure code quality.
4. Keep Branches Updated: Regularly pull changes from main to avoid large conflicts.
5. Communicate with Your Team: Use GitHub issues or comments to discuss tasks and updates.

---

Deliverables

1. A fully functional Node.js + MySQL - Boilerplate APILinks to an external site. backend with:

• Email sign-up and verification.
• JWT authentication with refresh tokens.
• Role-based authorization.
• Forgot password and reset password functionality.
• CRUD operations for managing accounts.

2. A fully functional Vue 3 BoilerplateLinks to an external site. frontend with:

• Email sign-up and verification.
• JWT authentication with refresh tokens.
• Role-based authorization.
• Profile management.
• Admin dashboard for managing accounts.
• Fake backend implementation for backend-less development.

3. A clean and well-maintained GitHub repository with:

• Proper branching structure.
• Reviewed and merged pull requests.
• Resolved merge conflicts.

4. Comprehensive README.md documentation covering installation, usage, testing, and contributing guidelines.
5. Test reports from testers ensuring the application is functional and secure.

---

Evaluation Criteria

Each team member will be evaluated individually based on:

1. Code Quality: Clean, modular, and well-documented code.
2. Functionality: Correct implementation of assigned features.
3. Collaboration: Effective use of Git and GitHub for collaboration.
4. Problem-Solving: Ability to resolve merge conflicts and debug issues.
5. Testing: Thoroughness of testing and quality of test reports.

---