# karasu-huginn/3apis architecture

> Architecture diagram of the GitHub repository karasu-huginn/3apis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/karasu-huginn/3apis
- Repository: https://github.com/karasu-huginn/3apis

## Overview

##### Project type and purpose
- This is a small monolithic REST-API server built with Node.js/Express for a school project called “3APIS.”
- It exposes three resource domains (“users,” “restaurants,” “menus”) via HTTP endpoints and persists data in a single database.

##### File structure
- Top-level artifacts:
- package.json / package-lock.json (npm metadata & dependencies)
- README.md (project description)
- src/ (all server code)
- src/index.js – entry point: initializes Express, middleware, and mounts routers
- src/database.js – database connection setup (e.g., Sequelize, Mongoose, or raw driver)
- src/routers/*.js – Express Router definitions for each resource (URL → controller)
- src/models/*.js – data-access layer / ORM model definitions for each resource

##### README for additional insights
- The README simply names it “3APIS” and marks it as a school project.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client[/"API Consumer"/]:::external
    Express["Express HTTP Server"]:::server
    Middleware["Middleware\n(e.g., auth, logging)"]:::middleware
    subgraph "Router Layer"
        UsersRouter["Users-Router\nGET/POST /users"]:::router
        RestaurantsRouter["Restaurants-Router\nGET/POST /restaurants"]:::router
        MenusRouter["Menus-Router\nGET/POST /menus"]:::router
    end
    subgraph "Controller Layer"
        UsersController["Users-Controller"]:::controller
        RestaurantsController["Restaurants-Controller"]:::controller
        MenusController["Menus-Controller"]:::controller
    end
    subgraph "Model Layer"
        UserModel["User-Model"]:::model
        RestaurantModel["Restaurant-Model"]:::model
        MenuModel["Menu-Model"]:::model
    end
    Database[(Database)]:::database
    Docs["Project Docs\nREADME.md"]:::docs
    Meta["package.json"]:::docs

    Client -->|"HTTP Request"| Express
    Express --> Middleware
    Middleware --> UsersRouter
    Middleware --> RestaurantsRouter
    Middleware --> MenusRouter
    UsersRouter --> UsersController
    RestaurantsRouter --> RestaurantsController
    MenusRouter --> MenusController
    UsersController --> UserModel
    RestaurantsController --> RestaurantModel
    MenusController --> MenuModel
    UserModel --> Database
    RestaurantModel --> Database
    MenuModel --> Database

    click Express "https://github.com/karasu-huginn/3apis/blob/main/src/index.js"
    click Database "https://github.com/karasu-huginn/3apis/blob/main/src/database.js"
    click UsersRouter "https://github.com/karasu-huginn/3apis/blob/main/src/routers/users-router.js"
    click RestaurantsRouter "https://github.com/karasu-huginn/3apis/blob/main/src/routers/restaurants-router.js"
    click MenusRouter "https://github.com/karasu-huginn/3apis/blob/main/src/routers/menus-router.js"
    click UsersController "https://github.com/karasu-huginn/3apis/blob/main/src/controllers/users-controller.js"
    click RestaurantsController "https://github.com/karasu-huginn/3apis/blob/main/src/controllers/restaurants-controller.js"
    click MenusController "https://github.com/karasu-huginn/3apis/blob/main/src/controllers/menus-controller.js"
    click UserModel "https://github.com/karasu-huginn/3apis/blob/main/src/models/user-model.js"
    click RestaurantModel "https://github.com/karasu-huginn/3apis/blob/main/src/models/restaurant-model.js"
    click MenuModel "https://github.com/karasu-huginn/3apis/blob/main/src/models/menu-model.js"
    click Meta "https://github.com/karasu-huginn/3apis/blob/main/package.json"
    click Docs "https://github.com/karasu-huginn/3apis/blob/main/README.md"

    classDef external fill:#E8F4FD,stroke:#B3D7F4,stroke-width:2
    classDef server fill:#FFE082,stroke:#F9A825,stroke-width:2
    classDef middleware fill:#E0F7FA,stroke:#4DD0E1,stroke-width:2
    classDef router fill:#BBDEFB,stroke:#1E88E5,stroke-width:2
    classDef controller fill:#C8E6C9,stroke:#43A047,stroke-width:2
    classDef model fill:#FFCCBC,stroke:#E64A19,stroke-width:2
    classDef database fill:#B0BEC5,stroke:#455A64,stroke-width:2,shape:cylinder
    classDef docs fill:#F3E5F5,stroke:#8E24AA,stroke-width:2
```
