This project runs containerized so there should be no issues getting it off the ground. Please make sure that either your docker daemon is running, or you have Docker Desktop open (which does essentially the same thing.)
You will need to setup the environment variables used in this project. Start by copying the .env.exanple to .env. The command to do so in the terminal if you need it is (assuming you are in the root of the project):
cp .env.example .env
Then fill out the contents of the .env file. Note that the AUTH_SECRET is a 32 character string and should be completely random.
To start the project for the first time run:
docker compose up --build
This may take some time depending on your internet connection as it needs to grab the postgres image, as well as build the custom image as part of the project.
While that downloads feel free to open the codebase your editor of choice and start taking a look around the template. We are using Air for hot reloading and there's a volume connected to root of the project so you will be able to edit everything directly.
If you've built the project before you can ignore the build flag when starting the project:
docker compose up
However, if something has gone horribly wrong you can try rebuilding with the --build flag again. Just keep in mind that this will create a dangling image that's used for the build step so please run the following as clean up:
docker image prune -f
This will remove all the unused dangling images lying around on your system.
Once you are done with development and want to shut down the project, first hit Ctrl + C in whatever session it is running. Once it has gracefully stopped (or just hard kill it :gigachad:) run the following:
docker compose down
Keep in mind that everything you store in the database is stored locally in a volume, so you should be able to pick up right where you left off with whatever had already been setup.
The project is structured as Controller Service Repository. The routes directory will maintain all the endpoints a user could call, grouped in their respective files. The same can be said for the controllers and services related to each. The current project directory structure is built as:
.
├── Dockerfile
├── README.md
├── controllers
│ └── user-controller.go
├── docker-compose.yml
├── dto
│ └── auth-body.dto.go
├── go.mod
├── go.sum
├── helpers
│ └── response-builder.go
├── initialize
│ ├── connect-database.go
│ └── sync-database.go
├── main.go
├── middleware
│ └── authentication.go
├── models
│ └── users.go
├── routes
│ ├── auth-routes.go
│ └── user-routes.go
└── services
└── jwt_service.go
Will place the controller template structure here when I've built the template file.
Will place the service template structure here when I've built the template file.
Linting is done using golangci-lint run, which will show all the errors in the project. There is also an action runner that will do the same, but ideally the linting should be run locally first before the runner has to pick it up.