• Stars
    star
    2,182
  • Rank 21,051 (Top 0.5 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created almost 6 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

https://start.spring.io

start.spring.io initializr

This repository configures a Spring Initializr instance with a custom UI running at https://start.spring.io. The following modules are available:

  • start-client: client-side assets

  • start-site: server infrastructure and metadata configuration

  • start-site-verification: tests to verify the validity of the metadata

Using

There is a dedicated page that describes how you can interact with the service.

Building from Source

You need Java 17 and a bash-like shell.

Building

Invoke the build at the root of the project

$ ./mvnw clean install

The project also includes a number of longer-running verification tests. They can be built and run using the verification profile:

$ ./mvnw -Pverification clean install

The project’s other tests are not included in the verification profile. All of the project’s tests can be run using the full profile:

$ ./mvnw -Pfull clean install

If building start-client fails, you may have an outdated cache that can be deleted as follows:

$ cd start-client
$ rm -rf .cache node_modules

Running the app locally

As long as you’ve built the project beforehand (in particular start-client), you can easily start the app as any other Spring Boot app:

$ cd start-site
$ ../mvnw spring-boot:run

Running the app in an IDE

You should be able to import the project into your IDE with no problems. Once there you can run the StartApplication from its main method and debug it. If you also need to work on the library, adding the initializr project in your workspace would make sure to reload the app whenever you make any change.

This is the recommended way to operate while you are developing the application, especially the UI.

Reusing the Web UI

This instance has a thin layer with our opinions about getting started with Spring Boot. You can reuse them but please keep in mind that this is not supported with the same level as the Spring Initializr library. The Web UI, in particular, is for our own purpose and is not particularly engineered to be easily extended.

Deploying to Cloud Foundry

If you are on a Mac and using homebrew, install the Cloud Foundry CLI:

$ brew install cloudfoundry-cli

Alternatively, download a suitable binary for your platform from Pivotal Web Services.

You should ensure that the application name and URL (name and host values) are suitable for your environment before running cf push.

First, make sure that you have built the application, then make sure first that the jar has been created:

$ cd start-site
$ ../mvnw package

The project creates a regular library jar and a repackaged archive that can be used to start the application with the exec classifier. Once the build as completed, you can push the application:

$ cf push your-start -p target/start-site-exec.jar

License

The start.spring.io website is Open Source software released under the Apache 2.0 license.

More Repositories

1

initializr

A quickstart generator for Spring projects
Java
3,409
star
2

spring-javaformat

Java
789
star
3

nohttp

A project for ensuring that https is used
Java
222
star
4

github-changelog-generator

Generates release notes that can be published to GitHub
Java
106
star
5

spring-asciidoctor-backends

A backend for Asciidoctor used to produce Spring styled HTML
Java
77
star
6

spring-asciidoctor-extensions

Asciidoctor Extensions developed by the Spring team
Java
45
star
7

spring-doc-resources

Asciidoctor theme for Spring reference documentations
SCSS
40
star
8

dataflow.spring.io

Microsite for Spring Cloud Data Flow
JavaScript
39
star
9

spring-calendar

Java
29
star
10

concourse-java-scripts

Shell
19
star
11

artifactory-resource

Java
18
star
12

antora-ui-spring

CSS
14
star
13

issue-bot

Java
12
star
14

pivotal-cla

Java
10
star
15

develocity-conventions

Java
8
star
16

antora-extensions

Antora extensions developed for the Spring docs.
JavaScript
7
star
17

backport-bot

GitHub Action used to help manage backports
Kotlin
7
star
18

spring-antora-maven-plugins

Antora support for Maven based projects
Java
6
star
19

slackboot

Slack bot names "slackboot" that helps manage guides, etc. from Slack
Java
6
star
20

spring-github-workflows

GitHub Actions Workflows for Spring Projects
6
star
21

homebrew-tap

A brew tap repository for formulae published by spring.io
Ruby
4
star
22

concourse-release-scripts

Promotes and distributes build artifacts using the Artifactory and Bintray APIs
Java
3
star
23

autoln

HTML
3
star
24

spring-io-static

static resources for our CDN
2
star
25

spring-security-release-tools

Libraries and plugins for managing automated releases of Spring projects.
Java
2
star
26

asciidoctor-extensions

Asciidoctor extensions (currently Asciidoctor.js only) developed for the Spring docs.
JavaScript
1
star
27

projects-api

Java
1
star
28

spring-generated-docs

Contains generated materials for Spring Security Antora docs
1
star
29

spring-gradle-build-action

Reusable GitHub Action for performing a gradle build or running a gradle task.
Shell
1
star
30

cve-2022-22976-bcrypt-skips-salt

Java
1
star
31

google-chat-notify-resource

Java
1
star
32

spring-io.github.io

1
star
33

antora-xref-extension

JavaScript
1
star
34

nexus-sync-action

TypeScript
1
star