Installation

Install and set up the goserve framework in your Go project.

Installation Methods

Using go get

go get github.com/afteracademy/goserve

Using go.mod

Add to your go.mod file:

module your-project

go 1.21

require (
    github.com/afteracademy/goserve v2.1.1
)

Then run:

go mod tidy

Version Selection

Check available versions:

go list -m -versions github.com/afteracademy/goserve

Install a specific version:

go get github.com/afteracademy/goserve@v2.1.1

Dependencies

goserve includes the following dependencies (automatically managed):

• Gin - HTTP web framework
• pgx - PostgreSQL driver (for PostgreSQL support)
• github.com/redis/go-redis - Redis client (for Redis support)
• github.com/go-playground/validator - Validation library
• github.com/spf13/viper - Configuration management
• golang.org/x/crypto - Cryptographic utilities

Verify Installation

Check if goserve is installed:

go list -m github.com/afteracademy/goserve

You should see output like:

github.com/afteracademy/goserve v2.1.1

Import in Your Code

import (
    "github.com/afteracademy/goserve/network"
    "github.com/afteracademy/goserve/postgres"  // For PostgreSQL
    "github.com/afteracademy/goserve/redis"    // For Redis
    "github.com/afteracademy/goserve/middleware" // For middleware
)

Project Setup

1. Initialize Go Module

mkdir my-project
cd my-project
go mod init my-project

2. Install goserve

go get github.com/afteracademy/goserve

3. Create Basic Structure

my-project/
├── cmd/
│   └── main.go
├── api/
│   └── (your features)
├── config/
│   └── config.go
└── go.mod

Database Drivers (Optional)

PostgreSQL

If you need PostgreSQL support:

go get github.com/afteracademy/goserve/postgres

Redis

If you need Redis support:

go get github.com/afteracademy/goserve/redis

Troubleshooting

Module Not Found

If you get "module not found" errors:

# Clean module cache
go clean -modcache

# Download dependencies
go mod download

# Verify modules
go mod verify

Version Conflicts

If you encounter version conflicts:

# Update all dependencies
go get -u ./...

# Or update specific package
go get -u github.com/afteracademy/goserve@latest

Go Version

Ensure you're using Go 1.21 or higher:

go version

If you need to update Go, visit golang.org/dl

Next Steps

• ✅ Installation complete? Start with Getting Started
• 🏗️ Learn about Framework Architecture
• 🔧 Configure your setup: Configuration Guide