# Initializr

**Repository Path**: mirrors_SteeltoeOSS/Initializr

## Basic Information

- **Project Name**: Initializr
- **Description**: Steeltoe Initializr - .NET Microservices Templates
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# :bangbang: This repository is for the old Initializr site.  Future work is being performed in the following repos [InitializrWeb - Front-end UI](https://github.com/SteeltoeOSS/InitializrWeb), [InitializrApi - Backend Api](https://github.com/SteeltoeOSS/InitializrApi), and [InitializrConfig - Configuration and Dependency Templates](https://github.com/SteeltoeOSS/InitializrConfig). 
## You can open issues in any of the above repositories, or use [InitializrWeb](https://github.com/SteeltoeOSS/InitializrWeb) and the team can move them around.


----

# [Steeltoe Initializr](https://start.steeltoe.io)

| Branch   | Build Status |
| :---     | :---         |
| `master` | ![image](https://dev.azure.com/SteeltoeOSS/Steeltoe/_apis/build/status/SteeltoeOSS.initializr?branchName=master) |
| `dev`    | ![image](https://dev.azure.com/SteeltoeOSS/Steeltoe/_apis/build/status/SteeltoeOSS.initializr?branchName=dev) |

* [Overview](#overview)
* [How to Use](#how-to-use)
* [Build and Run](#build-and-run)
* [Add A Library](#add-a-library)

## Overview
Steeltoe Initializr [start.steeltoe.io](https://start.steeltoe.io) provides an extensible API to generate quickstart projects. It provides a simple web UI to configure the project to generate and endpoints that you can use via plain HTTP.

Steeltoe Initializr also exposes an endpoint that serves its metadata in a well-known
format to allow third-party clients to provide the necessary assistance.

## How to Use

### Web

The Web UI allows you to quickly generate a CSharp project with your choice of dependencies

 ![image](https://media.giphy.com/media/IdP0OiDeK0dTLIW1Qe/giphy.gif)


### Curl

To get help:

```
curl https://start.steeltoe.io/

          (
          )\ )    )           (     )
         (()/( ( /(   (    (  )\ ( /(        (
          /(_)))\()) ))\  ))\((_))\()) (    ))\
  ____   (_)) (_))/ /((_)/((_)_ (_))/  )\  /((_)__ __ __
 / /\ \  / __|| |_ (_)) (_)) | || |_  ((_)(_))  \ \\ \\ \
< <  > > \__ \|  _|/ -_)/ -_)| ||  _|/ _ \/ -_)  > >> >> >
 \_\/_/  |___/ \__|\___|\___||_| \__|\___/\___| /_//_//_/

Dependencies:
+----------------------------------------+----------------------------------------------------------------------------------------------------+
+ Title                                  + Description                                                                                        +
+----------------------------------------+----------------------------------------------------------------------------------------------------+
+ Actuators                              + Add management endpoints for your application                                                      +
+ Circuit Breakers                       + Add Circuit Breakers                                                                               +
+ Cloud Foundry                          + Target CloudFoundry Hosting                                                                        +
+ Discovery                              + Add Discovery Client                                                                               +
+ DynamicLogger                          + Add Dynamic Logger                                                                                 +
...
```

To generate projects:

```
curl https://start.steeltoe.io/starter.zip -d dependencies=actuators,cloudfoundry -o myProject.zip
```

To get a list of dependencies:
```
curl https://start.steeltoe.io/api/templates/dependencies
```

## Build and Run

Clone and cd into repo and :
```
dotnet build                                          # build
dotnet test --filter "Category!=Integration"           # unit test suite
dotnet test --filter "Category=Integration"            # integration test suite
dotnet run --project src/Steeltoe.Initializr.WebApp   # run
```

## Add a Library

Would you like have a library added to [start.steeltoe.io](https://start.steeltoe.io)?  Please read and follow the [third party library contribution guidelines](THIRD-PARTY-CONTRIBUTIONS.md).  If the project fulfills the requirements, please create a new issue on this project and our team will help get you started.