https://github.com/nicktheodoro/service-management
This API facilitates service management within a Golang application, leveraging the Gin Framework and Gorm ORM.
https://github.com/nicktheodoro/service-management
api-rest gin-framework go golang gorm-orm jwt-authentication postgresql tests
Last synced: 3 months ago
JSON representation
This API facilitates service management within a Golang application, leveraging the Gin Framework and Gorm ORM.
- Host: GitHub
- URL: https://github.com/nicktheodoro/service-management
- Owner: nicktheodoro
- License: mit
- Created: 2024-01-20T00:34:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T23:56:32.000Z (over 2 years ago)
- Last Synced: 2025-01-10T03:53:21.854Z (over 1 year ago)
- Topics: api-rest, gin-framework, go, golang, gorm-orm, jwt-authentication, postgresql, tests
- Language: Go
- Homepage:
- Size: 128 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Service Management API
## Overview
This example API, crafted with the Gin framework and Gorm, stands as a mature solution for effective service management within Golang applications. By embracing Go's conventions, the project structure adheres to best practices. The REST architecture is implemented, aligning with Golang standards to ensure clean semantics and maintainability.
## Installation
Before running the application, ensure you have the necessary dependencies installed. Follow the steps below:
1. **Install Go (Golang):**
Download and install Go from [golang.org](https://golang.org/dl/). Verify the installation by running:
```bash
go version
```
2. **Download Dependencies:**
Run the following command to download the project dependencies:
```bash
go mod download
```
## Run the application
```bash
go run .\cmd\server\main.go
```
## Run tests
```shell script
go test -v ./test/...
```
## Generate Docs
```shell script
# Get swag
go get -u github.com/swaggo/swag/cmd/swag
# Generate docs
swag init --dir cmd/server --parseDependency --output docs
```
## Contributing
Contributions are welcome! Please feel free to open issues or pull requests to suggest improvements or add new features.
## License
This project is licensed under the [MIT License](./LICENSE).