Home

GREAT STAFF Wiki Outline

1. Introduction 📃

• 1.1 Project Overview 📋
• 1.2 Tech Stack 📦
• 1.3 Local Setup 🔧

2. Frontend 🖥️

• 2.1 Structure 📂
  • 2.1.1 Available Pages
  • 2.1.2 State Management
  • 2.1.3 API Integration
• 2.2 Using the Frontend 💻
  • 2.2.1 User Authentication
  • 2.2.2 Project Management
  • 2.2.3 Edit Project & Profiles
  • 2.2.4 Assign Team
  • 2.2.5 Employee Management
  • 2.2.6 Edit Employee & Target Skills
  • 2.2.7 Global Skill Categories
• 2.3 Extending the Frontend 🛠️
  • 2.3.1 Adding New Components
  • 2.3.2 Implementing New Features
  • 2.3.3 Styling and UI/UX Improvements

3. Backend 🔧

• 3.1 Structure 📂
  • 3.1.1 Routes
  • 3.1.2 Middleware
  • 3.1.3 Controller
  • 3.1.4 Services
  • 3.1.5 Models
• 3.2 Using the Backend 🛠️
  • 3.2.1 API Endpoints
  • 3.2.2 Authentication and Authorization
  • 3.2.3 Database Interactions
• 3.3 Extending the Backend 🔍
  • 3.3.1 Adding New Models
  • 3.3.2 Implementing New API Endpoints
  • 3.3.3 Enhancing Existing Services
  • 3.3.4 Adjusting the Matching Algorithm
  • 3.3.5 UML Diagram

4. MongoDB Database 🗄️

• 4.1 Schema Design ⚖️
• 4.2 Data Models+Structure 🔐
• 4.3 Relationships 🔄
• 4.4 Backup, Restore, and Daily Reset
• 4.5 MongoDB Configuration Secrets

5. Deployment, CI/CD & GitHub Actions 🚀

• 5.1 Docker Configuration 🐳
• 5.2 Branch Protection Rules 🔒
• 5.3 CI/CD Pipeline & Runners 🏃
• 5.4 CI/CD AWS Deployment Setup 💪
• Configuration Secrets 🔑

6. Testing 🧪

• 6.1 Backend Tests 🔙
  • Framework and Setup
  • Key Test Files
  • Running Backend Tests
  • CI/CD Integration
• 6.2 End-to-End Tests 🌐
  • Framework and Setup
  • Key Test Files
  • Running E2E Tests
  • CI/CD Integration
• Example E2E Tests

7. Security 🔐

• 7.1 Authentication and Authentication 🔑
• 7.2 Login Credentials