FernandoJVideira/LK_API_Temp
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: update README.md

Browse Source
This commit is contained in:
FernandoJVideira
2025-03-31 16:25:30 +01:00
parent 7e7af746d0
commit 4786ff9397
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -7
View File
@@ -17,11 +17,14 @@ A modern, production-ready API template built with Go and React, featuring compr
- Structured logging with Zap - Structured logging with Zap
- Hot reload support with Air - Hot reload support with Air
- **Frontend (React + TypeScript)** - **Frontend (Nuxt 3 + TypeScript)**
- Vite for fast development and building - Vue 3 with Composition API
- TypeScript support - TypeScript support
- ESLint configuration for code quality - Nuxt modules ecosystem
- Hot Module Replacement (HMR) - Hot Module Replacement (HMR)
- Auto-imports for components and composables
- Server-side rendering capabilities
- File-based routing
## 📋 Prerequisites ## 📋 Prerequisites
@@ -36,8 +39,8 @@ A modern, production-ready API template built with Go and React, featuring compr
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/yourusername/lk-api-template.git git clone https://github.com/FernandoJVideira/LK_API_Temp.git
cd lk-api-template cd LK_API_Temp
``` ```
2. Install backend dependencies: 2. Install backend dependencies:
@@ -81,8 +84,8 @@ cd web
npm run dev 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 ## 📚 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#/`