Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/embedmode/fiberseed
REST API Fiber boilerplate
https://github.com/embedmode/fiberseed
Last synced: about 2 months ago
JSON representation
REST API Fiber boilerplate
- Host: GitHub
- URL: https://github.com/embedmode/fiberseed
- Owner: embedmode
- License: mit
- Created: 2021-03-04T14:48:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-04T05:36:23.000Z (over 3 years ago)
- Last Synced: 2024-08-04T01:06:51.652Z (5 months ago)
- Language: Go
- Size: 39.1 KB
- Stars: 38
- Watchers: 2
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fiber - embedmode/fiberseed - Fiber boilerplate api with many middlewares. (🚧 Boilerplates / 🌱 Third Party)
README
# FiberSeed
REST API Fiber boilerplate
## ⭐️ Features
- REST API oriented
- Book CRUD example
- middleware
- compress
- CORS
- ETag
- recover
- helmet
- logger (optional)
- limiter (optional)
- Environment config with .env
- JSON Error handling
- GORM V2
- Docker
- Live reloading (Air or Fresh)
- Testing
## ⚙️ Usage
You can fork this repo or use [Fiberseed as a package](https://github.com/embedmode/fiberseed/blob/main/main.go)
- git clone https://github.com/embedmode/fiberseed.git
- Copy .env.example to .env
- Install postgres or use docker-compose up postgres
- go mod download
- go run .
- Go to localhost:8080
## 🚧 Development
> Check .env file for database variables
```sh
# Install postgres or use docker-compose
docker-compose up postgres
go test ./...
air
# or fresh
```
## 🐳 Docker
```sh
# postgres + server
docker-compose up
# Building and running docker image (you will need postgres)
docker build -t fiberseed .
docker run -d -p 8080:8080 fiberseed
# only postgres
docker-compose up postgres
```
## 📜 Changelog
We use [GitHub releases](https://github.com/embedmode/fiberseed/releases).
## 🔐 Security
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
## 📄 License
This project is licensed under the terms of the
[MIT license](/LICENSE).