Skip to content

CircleCI-Public/sample-go-cfd

Repository files navigation

Sample Go App

CircleCI Build Status Software License

Description

The sample Go app here is designed to demonstrate what a typical Go CI workflow may look on CircleCI.

You can see the CI pipelines for this application running live on CircleCI.

In this sample config, we have a single workflow build-and-test which will install and cache our required Go packages, and then run tests by running go test -v ./....

Getting Started

If you would like to copy the config.yml and adapt it to your project, be sure to read the comments in the config file to ensure it works for your project. For more details, see the CircleCI configuration reference.

About This App

This sample application is a Go REST API, and utilizes the entity framework to administer a SQL Server database running on the localhost. This application utilitzes the OpenAPI/Swagger specification.

Continuous Food Delivery

When you start up the service, you can open this page in your browser to view the available API endpoints.

Front-End

CFD(Continuous Food Delivery) is a sample application that relies on a separate UI framework. If you would like to run this project locally with a complete UI, you can use a valid CFD front-end, such as one of the following sample projects:

Language GitHub Description
Javascript (Vue.js) Link A Javascript Front-End for CFD

Run and Test Locally

If you would like to try this application out locally, you can find runtime instructions below.

Requirements

Postgres

Run Local Server

To run the server on a Docker container, please execute the following from the root directory:

docker compose up
go run main.go

Tests

To launch the unit tests, use the following:

go test -v ./...

Additional Resources

License

This repository is licensed under the MIT license. The license can be found here.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •