Vert.x Starter is an open-source web application for creating Vert.x applications.
Simply click on Generate Project on the web interface to download a project archive.
If you are a CLI adept, you can use any http client (curl, httpie) to invoke the API.
curl -G https://start.vertx.io/starter.zip \
-d "groupId=com.example" \
-d "language=java" \
--output starter.ziphttps://start.vertx.io/starter.{archiveFormat}
|
Note
|
archiveFormat can be zip, tgz, tar.gz, etc. if the project generator can handle the format, it will use the appropriate compression tool.
|
You can provide the following query parameters to customize the project:
-
Basic information for the generated project
groupId,artifactId -
language:javaorkotlin -
buildTool:mavenorgradlebuild tool -
vertxVersion: the Vert.x version -
vertxDependencies: a comma separated list of artifactIds of the vert.x modules -
packageName: code package name, derived fromgroupIdandartifactIdby default -
jdkVersion: which version of the JDK to use, defaults to11
Full example:
curl -G https://start.vertx.io/starter.zip \
-d "groupId=com.example" \
-d "artifactId=starter" \
-d "language=java" \
-d "buildTool=maven" \
-d "vertxDependencies=vertx-web,vertx-web-client"
--output starter.zipThe HTTPie equivalent:
http https://start.vertx.io/starter.zip \
groupId==com.example \
artitfactId==starter \
language==java \
buildTool==maven \
vertxDependencies==vertx-web,vertx-web-client \
-o starter.zipThe vert.x starter metadata lists all the capabilities proposed by the API. The metadata is used to build the Web UI is exposed to ease the creation of third-party clients (IDE integration, CLI, etc).
https://start.vertx.io/metadata
# Configure analytics dir
export VERTX_STARTER_ANALYTICS_DIR=target
# Build frontend first
./mvnw clean process-resources
# Run backend in redeploy mode
./mvnw compile vertx:run -Dskip.npm|
Note
|
The following commands assume you have forked the project and upstream is the vert-x3/vertx-starter remote repository.
|
To release the project, proceed as follows.
First, tag the last commit in master branch:
STARTER_VERSION=$(./mvnw org.apache.maven.plugins:maven-help-plugin:evaluate -Dexpression=project.version -B | grep -v '\[')
git tag -f -a ${STARTER_VERSION} -m "Version ${STARTER_VERSION}"
git push upstream --tagsClose the corresponding milestone on GitHub.
Then merge the master branch into the prod branch:
git checkout prod
git pull
git merge master
git pushGitHub Deploy job will automatically redeploy the starter if the prod branch build passes.
Eventually, checkout master again and update the version:
git checkout master
./mvnw versions:set -DgenerateBackupPoms=false
git add pom.xml
git commit -s
git push upstream && git pushVert.x Starter is Open Source software released under the Apache 2.0 license.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent