Skip to content

UCLALibrary/service-template

Repository files navigation

Service Template

This is a simple GoLang service template that utilizes Echo. It is meant to serve as the foundation for a variety of microservices.

Building the Project

To run the project run:

go run main.go

Creating a Docker image

To run on Docker first build the Docker image:

docker build -t service-template .

To specify what version of Go you would like to use with the Docker image:

docker build --build-arg GO_VERSION=[YOUR_VERSION] -t service-template .

To run the Docker image:

docker run -d -p 8888:8888 service-template

Compiling on ACT

We use ACT to build the project. Our GitHub Actions' workflow (which is also used locally by ACT) is pretty simple.

To get started, ensure that ACT is installed on your system.

Now that ACT is installed, you can see the workflow run locally by running:

act -j build

Contact

If you have any questions or suggestions, feel free to open a ticket on project's GitHub repo.