fix/update: docs folder added and folder-structure.md added

Author: Gauravst

README.md

@@ -12,6 +12,7 @@ A Production-Ready Go template to kickstart your next Go lang Project.
 - [Configuration](#configuration)
 - [Dependencies](#dependencies)
 - [Migrations](#migrations)
+- [Documentation](#Documentation)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -68,6 +69,10 @@ make migrate-up    # Apply migrations
 make migrate-down  # Rollback migrations
 ```
 
+## Documentation
+
+- [Folder Structure](docs/folder-structure.md)
+
 ## Contributing
 
 Feel free to open issues and submit PRs. All contributions are welcome!

docs/folder-structure.md

@@ -0,0 +1,59 @@
+# Folder Structure (GOT - Go Template)
+
+### Root Level:
+
+- `cmd/`
+  Main application entry point. For example, `cmd/got-api/` contains the code that starts your Go API server.
+
+- `configs/`
+  Configuration files (JSON). You can define different files for different environments like dev, prod, etc.
+
+- `docs/`
+  Project documentation (you are probably reading this from here). Good place to put extra docs like folder structure, setup, usage tips, etc.
+
+- `internal/`
+  Application-specific packages. This code is private to your app and cannot be imported by others.
+
+  - `internal/api/` – HTTP routes, handlers, and middleware.
+  - `internal/cli/` – CLI commands and utilities.
+  - `internal/config/` – Load and manage app configs.
+  - `internal/database/` – DB connection and setup logic.
+  - `internal/models/` – App data models (e.g. User, Token) for ORM/SQL.
+  - `internal/dto/` – Request and response data structs.
+  - `internal/repositories/` – DB queries and data access.
+  - `internal/services/` – Business logic and processing.
+  - `internal/utils/` – Helpers like JWT, email, hashing.
+
+- `migrations`  
+  SQL migration files used for database schema changes. Managed via `make migrate-up` and `make migrate-down` commands.
+
+- `test`  
+  Contains end-to-end (e2e) and integration tests.  
+  (Note: Unit tests are placed alongside the logic files using `_test.go` suffix, like `user_test.go`.)
+
+- `Makefile`
+  Automation commands for local development (`make setup`, `make dev`, etc.)
+
+- `Dockerfile`  
+  Defines how to build and run the app inside a Docker container.
+
+- `.dockerignore`  
+  Lists files and folders to exclude from the Docker build context.
+
+- `.env`  
+  Environment-specific variables used during local development.
+
+- `.env.example`  
+  A sample environment file to show required variables. Used as a reference.
+
+- `go.mod` / `go.sum`
+  Go module definition and dependencies.
+
+- `README.md`
+  Main documentation file with instructions, setup, features, etc.
+
+Of course Gaurav bhai! Here's the improved version of your summary:
+
+### Summary:
+
+This folder structure follows Go best practices. After running the `make setup` command, only the folders relevant to your selected features will remain — giving you a clean, minimal, and ready-to-use project structure.

internal/dto/user_request.go

@@ -0,0 +1,8 @@
+package dto
+
+type CreateUserRequest struct {
+	Name     *string `json:"name,omitempty"`
+	Email    string  `json:"email" validate:"required,email"`
+	Username *string `json:"username,omitempty"`
+	Password string  `json:"password" validate:"required,min=6"`
+}

internal/dto/user_response.go

@@ -0,0 +1,17 @@
+package dto
+
+import (
+	"time"
+)
+
+type UserResponse struct {
+	Id         string    `json:"id"`
+	Name       *string   `json:"name,omitempty"`
+	Username   *string   `json:"username,omitempty"`
+	Email      string    `json:"email"`
+	Role       string    `json:"role"`
+	ProfilePic *string   `json:"profile_pic"`
+	Status     string    `json:"status"`
+	CreatedAt  time.Time `json:"created_at"`
+	UpdatedAt  time.Time `json:"updated_at"`
+}