Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waxer59/basic-go-fiber-api
https://github.com/waxer59/basic-go-fiber-api
Last synced: about 4 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/waxer59/basic-go-fiber-api
- Owner: Waxer59
- License: mit
- Created: 2023-04-16T08:54:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-28T08:35:09.000Z (over 1 year ago)
- Last Synced: 2024-06-19T13:45:01.228Z (5 months ago)
- Language: Go
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FIBER API
The project is an API built in Go using the Fiber framework.
## Installation
1. Fill in the environment variables of the `.template.env` file and rename it to `.env`.
2. Build the project database using:
```bash
docker-compose up -d
```
3. Install project dependencies using:
```bash
go mod download
```
4. Run the project using:
```bash
go run cmd/main.go
# or
air
```
## Instructions
All the routes are documented in the path `/swagger`.
> Every time you make changes in the api and you want to rebuild the documentation you must use this command, in the root of the project:
> ```bash
> swag init --pd
> ```
## Technologies
* [Fiber](https://gofiber.io/)
* [Gorm](https://gorm.io/)
* [Swagger](https://github.com/gofiber/swagger)