agl-go-driver

README

agl-go-driver

💬 About

The project is a simple file storage API that allows users to upload and download files.

[!NOTE]

1. This project was developed following Aprenda Golang's "Imersão Backend" course.
2. Notes taken during the course are in the notes file.

🎨 Architecture

  C4Container
    title Personal Go Drive
    Person(customerA, "Customer A", "A customer of the drive API")

    Enterprise_Boundary(b0, "System") {  
      
      Container(web_interface, "Web Application", "Interface that allows consumers to access Drive API via Web")
      
      Container(api, "API", "Allows customers upload/download files from Drive")

      Container(cli_interface, "CLI", "Interface that allows consumers to access Drive API via terminal")

      Container(worker, "Worker", "Compress files and remove raw files")
      
      ContainerDb(db, "Storage", "Stores the links of the uploaded files")
      
      ContainerQueue(queue, "Queue")
    }

    System(bucket_raw, "Bucket Raw", "Save raw files")
    System(bucket_compress, "Bucket Compress", "Save compress files")

    BiRel(customerA, web_interface, "HTTP")
    BiRel(customerA, cli_interface, "Terminal")
    Rel_D(cli_interface, api, "Save/Get link")
    Rel_D(web_interface, api, "Save/Get link")
    Rel_D(api, db, "Save/Get link")
    Rel_D(api, queue, "Save/Get link")
    Rel_D(api, bucket_raw, "Save/Get link")
    Rel_D(queue, worker, "Get raw files")
    Rel_D(worker, bucket_compress, "Save compressed files")

[!NOTE]

1. The following diagram was generated using Mermaid.
2. It is a C4 model diagram at the container level, see more at C4 Model.

🗃 Database

  erDiagram
    folder {
        INT id
        INT parent_id
        STRING name
        DATETIME created_at
        DATETIME updated_at
        BOOL deleted
    }

    file {
        INT id
        INT folder_id
        INT owner_id
        STRING name
        STRING type
        STRING path
        DATETIME created_at
        DATETIME updated_at
        BOOL deleted
    }

    user {
        INT id
        STRING name
        STRING login
        STRING password
        DATETIME created_at
        DATETIME updated_at
        DATETIME last_login
        BOOL deleted
    }

    user ||--o{ file : "one to many"
    folder ||--o{ file : "one to many"
    folder ||--o{ folder : "one to many"

💻 Technologies

• Go
• AWS SDK Go
• PostgreSQL
• Data Dog - SQLMock
• Testify
• Chi
• RabbitMQ
• Cobra
• Docker

(back to top)

📜 Requirements

• Go
• Docker

(back to top)

💿 Installation

git clone git@github.com:filipe1309/agl-go-driver.git

cd agl-go-driver

(back to top)

🏃 Running

make run

Access http://localhost

(back to top)

🚦 Roadmap

• replace aws-sdk-go with aws-sdk-go-v2

📝 License

MIT

(back to top)

🧙‍♂️ About Me

(back to top)

👏 Acknowledgments

• ShubcoGen Template™
• Aprenda Golang
• C4 Model
• Mermaid
• Go
• Testing REST API in Go with Testify and Mockery

(back to top)

---

Done with  ♥️  by filipe1309 🖖

---