Skip to content

Becklyn/gocruddy

Repository files navigation

Becklyn gocruddy

CI codecov

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 as router and gorm as ORM.

Installation

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:

make setup

Add new modules / dependencies:

make install MOD=your.dependency/name

Tidy up modules:

make tidy

Test your implementation:

make test

Calculate the code coverage: (This currently requires a local go installation)

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 Logging
github.com/ao-concepts/storage DB abstraction
github.com/gofiber/fiber HTTP router
github.com/stretchr/testify Testing
gorm.io/gorm ORM