README.md

FiberEnt | Clean Architecture in Go 🎉

FiberEnt is a clean architecture implementation in Go with the following frameworks:

• Fiber 🚀 is an Express inspired web framework built on top of Fasthttp, the fastest HTTP engine for Go.
• Ent 🎉 is an entity framework for Go, Simple, yet powerful ORM for modeling and querying data.

Start development

Docker must be installed.

Start docker container

  make docker-dev # or docker-compose up

then migrate database

  make migrate

Steps to create a new entity

Install Ent entity framework, check out https://entgo.io/docs/getting-started#installation for more information.

In the following example, we will create a new entity called User.

1. Create an entity schema

   go run entgo.io/ent/cmd/ent init User # User is the name of the entity

2. Open up <project>/ent/schema/user.go

   • add your fields to the User schema, check Ent Field creation for more information.
   • add your edges to the User schema, check Ent Edges creation for more information.

3. Run go generate from the the project root directory.

   go generate ./ent

4. Create user entity file <project>/entity/user.go.

5. Define the user repository (Reader and Writer) Interface and the usecase (service) Interface in the <project>/usecase/user folder

6. Create the User service Implementation of the Usecase interface in the <project>/usecase/user/service.go.

7. Create the User repository implementation of the Repository interface in the <project>/infrastructure/ent/repository/user_ent.go.

8. Add the handler <project>/api/handler/user.go and the presenter <project>/api/presenter/user.go files.

9. Update <project>/api/main.go file with the new endpoint.

API requests

Add a user

curl -X "POST" "http://localhost:3030/api/v1/users" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
          "email": "adil@mail.com",
          "first_name": "Adil",
          "last_name": "Chehabi",
          "password": "password"
          }'

Update a user

curl -X "POST" "http://localhost:3030/api/v1/users/[USER_ID]" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
          "email": "adil@mail.com",
          "first_name": "Adil",
          "last_name": "Chkilel",
          "password": "password"
          }'

Get a user

curl "http://localhost:3030/api/v1/users/[USER_ID]" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

Delete a user

curl -X "DELETE" "http://localhost:3030/api/v1/users/[USER_ID]" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

List all users

curl "http://localhost:3030/api/v1/users" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'