This is a project that will display a list of issues that pertain the repository given. This was a project used for experimenting with the technologies below:
- Go with the Gin Web Framework for the backend
- Go Templating and HTMX for the frontend
- Tailwind for styling
- Github's GraphQL API for the data
Some notable tools used for this project were:
- Genqlient for the GraphQL query to Golang code generation
- Microsoft Dev Containers for a consistant development environment
- Docker for containerization
To start the Devcontainer copy the .devcontainer/.env.example, name the copy .env and leave it in the
.devcontainer directory. Provide a value for ENV, PORT and GH_PAT.
ENVtells the application what environment it is running in,PRODwould run Gin in Release ModePORTtells the application what port it should use to receive requestsGH_PATgives the application permission to perform actions on your behalf via the Github API, if you don't have a personal access token from Github yet, you can create one by following this link and then create aFine-grained tokenno specific permissions are needed.
After the environment variables, open the Makefile and set the MOD_NAME variables, this will be the name of the
the application.
If you have the devcontainer cli installed you can run the make commands below:
make dc_upOnce it has finished, you can open a VSCode instance in that container with the command:
make dc_openIf you don't have the Dev Container CLI, you can use the Dev Containers VSCode extension instead. In the VSCode command
palette, run the command Dev Containers: Reopen in Container, this would create a container with your code inside and
open VSCode with a remote connection already with Go installed.
Once inside the Dev Container, open a terminal and change your directory to the workspaces/src, from there you can
install the Project dependencies with the command:
make initTo run the application, run the command:
make run