2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:25:53 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:17:35 +01:00
2025-03-31 16:25:30 +01:00

LK API Template

A modern, production-ready API template built with Go and React, featuring comprehensive authentication, mailing capabilities, and automatic API documentation.

🚀 Features

  • Backend (Go)

    • Chi router for efficient HTTP routing
    • Swagger/OpenAPI documentation
    • SendGrid integration for email notifications
    • Rate limiting support
    • Redis caching
    • PostgreSQL database integration
    • JWT-based authentication
    • Environment-based configuration
    • Structured logging with Zap
    • Hot reload support with Air
  • Frontend (Nuxt 3 + TypeScript)

    • Vue 3 with Composition API
    • TypeScript support
    • Nuxt modules ecosystem
    • Hot Module Replacement (HMR)
    • Auto-imports for components and composables
    • Server-side rendering capabilities
    • File-based routing

📋 Prerequisites

  • Go 1.21 or higher
  • Node.js 18 or higher
  • PostgreSQL
  • Redis
  • SendGrid API key (for email functionality)

🛠️ Installation

  1. Clone the repository:
git clone https://github.com/FernandoJVideira/LK_API_Temp.git
cd LK_API_Temp
  1. Install backend dependencies:
go mod download
  1. Install frontend dependencies:
cd web
npm install
  1. Set up environment variables:
cp .env.example .env
# Edit .env with your configuration

🚀 Development

Backend

Run the backend server with hot reload:

air

The API will be available at http://localhost:8080 with the base path /v1.

Frontend

Run the frontend development server:

cd web
npm run dev

The frontend will be available at http://localhost:3000 (default Nuxt port).

📚 API Documentation

The API documentation is automatically generated using Swagger. Once the server is running, you can access the Swagger UI at: http://localhost:8080/v1/swagger/index.html#/

S
Description
No description provided
Readme
29 MiB
Languages
Go 98.5%
Makefile 0.8%
TypeScript 0.4%
JavaScript 0.2%
Vue 0.1%