Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
create-vertx-app
Advanced tools
Readme
This is a simple online generator for vert.x projects
The whole SPA is data-driven, build tools can be added to the file metadata/buildtools.json.
Build the required files with
gulp build-cli
And then run the cli with
npm run cli
If you want a zip output you can use -z
flag
Look at preset specific documentation for more info:
buildtools.json
file is composed of several properties:
id
an unique id for the toolfile
just a placeholder to show on screen (has no side effects)fields
a list of properties that will be available to the template enginelanguages
supported languagestemplates
simple templates that apply to all languagesdefaults
default dependencies that are automatically selected for this toolexecutables
list of template elements that should be marked as executable (required for Unix OSes)blob
an existing zip file that will be merged into the final zipA field
can be seen as a variable that can be used later on the code generation.
It allows the following properties:
key
unique idlabel
the label for the keyrequired
booleanprefill
a default value for the keytype
of the field. Allowed: input
, checkbox
, file
. Default: input
Note on type: file
: In browser files are feed in the engine as string UTF-8 decoded, while on CLI they are paths to the file
A language represents a programming language and has the following properties:
id
an unique id (should match the vertx-lang-xxx
)templates
an extra list of templates for this languageComponents represent all dependencies you can add to the project. Components can be added to the file components.json
Components have the following properties:
groupId
artifactId
version
stack
is the component part of the official stackdescription
core
is a special marker for languages like scala. If true it means that there are no prefixed artifactsPreset projects can be added to the generator. They are listed in the file presets.json.
A preset has the following properties:
id
an unique iddescription
a simple descriptiondependencies
a list of dependencies to be added by defaultbuildtool
the tool that this preset expect to be presentlanguage
the language this preset requirestemplates
a list of extra templates that are required for this preset (no file name translation will occurr)executables
a list of extra executable templates that are required for this presetblob
an existing zip file that will be merged into the final zip (will override build tool one)The generated project comes from the handlebars templates under templ
for each build tools there should be a folder. In this folder, all files will be handled as handlebars templates.
When dealing with templates that need to live in a specific package name the following rules apply:
some-dir/{packageName}/File.extension
some-dir/File.extension
Important to note that extra packages after the {packageName}
are allowed e.g.: some-dir/{packageName}/impl/File.extension
.
There is no build process except if templates are added/modified. In this case, handlebars needs to precompile the templates.
This can be done using NPM
, start by installing the required dependencies:
npm install
And then compile the templates:
npm run build
Increase the version in package.json
will generate a new sw.js
cache version and invalidate the old one.
FAQs
This is a simple online generator for vert.x projects
The npm package create-vertx-app receives a total of 52 weekly downloads. As such, create-vertx-app popularity was classified as not popular.
We found that create-vertx-app demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.