# craniacshencil/got-to-do architecture

> Architecture diagram of the GitHub repository craniacshencil/got-to-do, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/craniacshencil/got-to-do
- Repository: https://github.com/craniacshencil/got-to-do

## Overview

##### Main Components

a) Client Layer:
- External clients (curl/scripts) making HTTP requests
- Various bash scripts in the /scripts directory that interact with the API

b) API Layer:
- Entry point through cmd/main.go and routes
- Handlers from pkg/handlers/* showing different endpoints:
- Authentication handlers (login, signup)
- TODO list handlers (create, update, delete, display)
- Task handlers (add, delete)

c) Internal Services Layer:
- JWT authentication service (pkg/myJwt)
- Password handling service (pkg/passwords)
- Signup validation service (internal/signup)

d) Data Access Layer:
- Database interface (internal/database)
- SQL queries and models
- Separation between:
- Users and passwords
- Todo lists
- Tasks

e) Database Layer:
- PostgreSQL database
- Four main tables from sql/schema:
- users
- user_passwords
- todo_lists
- tasks

##### Specific Elements

a) Authentication Flow:
- Complete flow from login/signup requests
- JWT token generation and validation
- Password hashing and verification process

b) Data Flow:
- Request handling path from routes to handlers
- Database query flow through the data access layer
- Response path back to client

c) Infrastructure Elements:
- Docker container boundary
- Environment configuration (.env.local and .env.docker)
- Database connection configuration

##### Database Layer

Left to Right in each layer:
- Related functionality (auth, todo lists, tasks)
- Clear dependencies between components

##### Additional Notes

- Notes about Docker configuration
- Database migration flow
- Environment configuration impact
- Version information for major components

##### Technical Details to Emphasize

- Go-specific patterns used
- SQL query organization (using sqlc)
- Authentication mechanism (JWT)
- Password handling security
- Database schema relationships

Remember to maintain a balance between showing the technical implementation details and keeping the high-level architecture clear and understandable.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef external fill:#A0D8EF,stroke:#333
    classDef api fill:#90EE90,stroke:#333
    classDef service fill:#FFE5B4,stroke:#333
    classDef data fill:#FFA07A,stroke:#333
    classDef database fill:#DDA0DD,stroke:#333
    classDef script fill:#B0C4DE,stroke:#333

    %% Client Layer
    subgraph Clients
        CL["Client Scripts"]:::script
        click CL "https://github.com/craniacshencil/got-to-do/tree/main/scripts"
        CL --> |HTTP Requests| EP
    end

    %% API Layer
    subgraph API
        EP["Entry Point"]:::api
        click EP "https://github.com/craniacshencil/got-to-do/blob/main/cmd/main.go"
        RT["Routes"]:::api
        click RT "https://github.com/craniacshencil/got-to-do/blob/main/cmd/routes/routes.go"
        
        EP --> RT
    end

    %% Handlers Layer
    subgraph Handlers
        direction TB
        
        subgraph AuthHandlers
            LH["Login Handler"]:::api
            click LH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/loginHandler.go"
            SH["Signup Handler"]:::api
            click SH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/signupHandler.go"
        end

        subgraph TodoHandlers
            CLH["Create List"]:::api
            click CLH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/createListHandler.go"
            ULH["Update List"]:::api
            click ULH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/updateListHandler.go"
            DLH["Delete List"]:::api
            click DLH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/deleteListHandler.go"
            DSLH["Display List"]:::api
            click DSLH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/displayListHandler.go"
        end

        subgraph TaskHandlers
            ATH["Add Task"]:::api
            click ATH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/addToListHandler.go"
            DTH["Delete Task"]:::api
            click DTH "https://github.com/craniacshencil/got-to-do/blob/main/pkg/handlers/deleteTaskHandler.go"
        end
    end

    %% Services Layer
    subgraph Services
        JWT["JWT Service"]:::service
        click JWT "https://github.com/craniacshencil/got-to-do/blob/main/pkg/myJwt/jwt.go"
        PS["Password Service"]:::service
        click PS "https://github.com/craniacshencil/got-to-do/blob/main/pkg/passwords/passwords.go"
        SV["Signup Validation"]:::service
        click SV "https://github.com/craniacshencil/got-to-do/blob/main/internal/signup/validation.go"
    end

    %% Data Access Layer
    subgraph DataAccess
        DBI["Database Interface"]:::data
        click DBI "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/db.go"
        DBM["Database Models"]:::data
        click DBM "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/models.go"
        
        subgraph DataQueries
            UQ["Users Queries"]:::data
            click UQ "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/users.sql.go"
            PQ["Passwords Queries"]:::data
            click PQ "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/user_passwords.sql.go"
            TLQ["Todo Lists Queries"]:::data
            click TLQ "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/todo_lists.sql.go"
            TQ["Tasks Queries"]:::data
            click TQ "https://github.com/craniacshencil/got-to-do/blob/main/internal/database/tasks.sql.go"
        end
    end

    %% Database Layer
    subgraph Database
        PG[("PostgreSQL")]:::database
        
        subgraph Schema
            UT["Users Table"]:::database
            click UT "https://github.com/craniacshencil/got-to-do/blob/main/sql/schema/001_users.sql"
            UPT["User Passwords Table"]:::database
            click UPT "https://github.com/craniacshencil/got-to-do/blob/main/sql/schema/002_user_passwords.sql"
            TLT["Todo Lists Table"]:::database
            click TLT "https://github.com/craniacshencil/got-to-do/blob/main/sql/schema/003_todo_lists.sql"
            TT["Tasks Table"]:::database
            click TT "https://github.com/craniacshencil/got-to-do/blob/main/sql/schema/004_tasks.sql"
        end
    end

    %% Connections
    RT --> AuthHandlers
    RT --> TodoHandlers
    RT --> TaskHandlers
    
    LH & SH --> JWT
    SH --> SV
    LH & SH --> PS
    
    AuthHandlers & TodoHandlers & TaskHandlers --> DBI
    DBI --> DBM
    DBM --> DataQueries
    DataQueries --> PG
    PG --> Schema

    %% Legend
    subgraph Legend
        L1["Client Layer"]:::script
        L2["API Layer"]:::api
        L3["Service Layer"]:::service
        L4["Data Access Layer"]:::data
        L5["Database Layer"]:::database
    end
```
