Samples

(β˜… 648)

Steeltoe samples and reference application collection

  • .editorconfig
  • .gitattributes
  • .gitignore
  • behave.ini
  • behave.ps1
  • behave.sh
  • CommonTasks.md
  • CONTRIBUTING.md
  • environment.py
  • License.txt
  • logging.ini
  • nuget.config
  • Pipfile
  • Pipfile.lock
  • pyenv.pkgs
  • README.md
  • TESTS.md
  • user.ini.example

# Installation Guide

1. Get the code
git clone https://github.com/SteeltoeOSS/Samples

Downloads the entire project code from GitHub to your computer.

cd Samples

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f Management/src/docker-compose.yaml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd Configuration/src/ConfigurationProviders

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

βœ… After dotnet run, check the message or address shown in the terminal.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pipenv install

Type this command into your terminal and run it.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation