Git Product home page Git Product logo

initializr's Introduction

Branch Build Status
master image
dev image

Overview

Steeltoe Initializr 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

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

or

curl https://start.steeltoe.io/starter.zip -d dependencies=actuators,cloudfoundry -d templateShortName=Steeltoe-React -d projectName=MyCompany.MySample -o myProject.zip

To get a list of dependencies:

curl https://start.steeltoe.io/api/templates/dependencies

To get a list of valid templates:

curl https://start.steeltoe.io/api/templates/templates

Dotnet templates

Install the Steeloe Templates

dotnet new -i steeltoe.templates::2.2.1 --nuget-source https://www.myget.org/F/steeltoedev/api/v3/index.json

Generate project

dotnet new Steeltoe-WebApi --Actuators --CloudFoundry

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? Please read and follow the third party library contribution guidelines. If the project fulfills the requirements, please create a new issue on this project and our team will help get you started.

initializr's People

Contributors

ccheetham avatar ddieruf avatar dependabot[bot] avatar hananiel avatar jkonicki avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.