Introduction¶

This site contains documentation for the eShop example application. It complements the project README by focusing on developer workflows, repository layout, and handy commands to get started locally.

Quick links¶

• Development setup — getting the repo running locally
• Architecture — high-level overview of folders and services

Overview¶

eShop is a sample microservices-style application used as a reference for building cloud-native .NET applications. The repository contains multiple services and supporting projects under the src/ folder and tests in tests/.

Use this documentation to:

• Quickly onboard a new contributor
• Find development commands and tips
• Understand the repository structure and where to make changes

Quick start¶

Prerequisites: dotnet SDK (version in global.json), Node.js (for ClientApp), and Docker if you run services in containers.

Clone and build:

git clone https://github.com/Pinguteca/eShop.git
cd eShop
dotnet restore
dotnet build

Run a single API locally (example):

cd src/Identity.API
dotnet run

Run tests:

dotnet test ./tests/Ordering.UnitTests

Contributing¶

Please see the repository CONTRIBUTING.md and CODE-OF-CONDUCT.md at the project root for contribution guidelines.

If you're adding or changing a workflow, see .github/workflows and remember to avoid committing secrets in workflow files.