https://github.com/becklyn/gocruddy
golang crud api framework
https://github.com/becklyn/gocruddy
Last synced: 3 months ago
JSON representation
golang crud api framework
- Host: GitHub
- URL: https://github.com/becklyn/gocruddy
- Owner: Becklyn
- License: bsd-3-clause
- Created: 2021-09-01T09:58:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T16:28:01.000Z (about 1 year ago)
- Last Synced: 2025-01-14T03:13:56.239Z (4 months ago)
- Language: Go
- Size: 45.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Becklyn gocruddy
=================
[](https://github.com/Becklyn/gocruddy/actions/workflows/ci.yml)
[](https://codecov.io/gh/Becklyn/gocruddy)
Made with ❤ by Becklyn
A framework that supports you in creating CRUD APIs using go (golang).
This framework is useful for applications that use [fiber](https://github.com/gofiber/fiber) as router and [gorm](https://gorm.io/) as ORM.
Installation
------------
```shell
go get -u github.com/Becklyn/gocruddy
```
Usage
-----
You can find a working example in the `example` directory of this repository.
The folder also contains a postman template that demonstrates the API usage.
Development
-----------
Set up your local development environment:
````shell
make setup
````
Add new modules / dependencies:
```shell
make install MOD=your.dependency/name
```
Tidy up modules:
```shell
make tidy
```
Test your implementation:
```shell
make test
```
Calculate the code coverage:
(This currently requires a local go installation)
```shell
make cover
```
References
----------
This project makes use of some really great packages. Please make sure to check them out!
| Package | Usage |
| ------------------------------------------------------------------------ | -------------- |
| [github.com/ao-concepts/logging](https:/github.com/ao-concepts/logging) | Logging |
| [github.com/ao-concepts/storage](https://github.com/ao-concepts/storage) | DB abstraction |
| [github.com/gofiber/fiber](https://github.com/gofiber/fiber) | HTTP router |
| [github.com/stretchr/testify](https://github.com/stretchr/testify) | Testing |
| [gorm.io/gorm](https://gorm.io/) | ORM |