From 4786ff93977e443eb1459c960e300154fd6b78f1 Mon Sep 17 00:00:00 2001 From: FernandoJVideira <03.pleaser-minster@icloud.com> Date: Mon, 31 Mar 2025 16:25:30 +0100 Subject: [PATCH] fix: update README.md --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 143930e..5aa5422 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,14 @@ A modern, production-ready API template built with Go and React, featuring compr - Structured logging with Zap - Hot reload support with Air -- **Frontend (React + TypeScript)** - - Vite for fast development and building +- **Frontend (Nuxt 3 + TypeScript)** + - Vue 3 with Composition API - TypeScript support - - ESLint configuration for code quality + - Nuxt modules ecosystem - Hot Module Replacement (HMR) + - Auto-imports for components and composables + - Server-side rendering capabilities + - File-based routing ## 📋 Prerequisites @@ -36,8 +39,8 @@ A modern, production-ready API template built with Go and React, featuring compr 1. Clone the repository: ```bash -git clone https://github.com/yourusername/lk-api-template.git -cd lk-api-template +git clone https://github.com/FernandoJVideira/LK_API_Temp.git +cd LK_API_Temp ``` 2. Install backend dependencies: @@ -81,8 +84,8 @@ cd web npm run dev ``` -The frontend will be available at `http://localhost:5173`. +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: +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#/` \ No newline at end of file