terianil / sample-dotnet-cfd

Sample .NET App - ASP.NET Core

Description

The sample .NET core app here is designed to demonstrate what a typical .NET core 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 .NET core packages, and then run tests with xunit by running dotnet test, a common .NET framework. This config makes use of the windows executor running SQL Server 2019, which is the database that this app uses to store data.

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 .NET core ASP.NET application, 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

SQL Server 2019

Run Local Server

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

dotnet restore src\Cfd
dotnet build src\Cfd
dotnet run

Tests

To launch the unit tests, use dotnet test:

dotnet test

Additional Resources

• CircleCI Docs - The official CircleCI Documentation website.
• CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have.

License

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