Skip to content

Using Template

1.2.0-experimental · Feature

If your project is new and want to use the codebase, using template is recommended as it's easier for you to use.

Info

Template now supported from version 1.2.0-experimental

Installing Libraries

For using the boilerplate template, first you need to install Node Package Manager. You can do that by following here.

Another thing you need to install is hygen, it's code generator based on javascript. By running this command

❯ npm i -g hygen

Setting Up Environment Variables

Ask maintainer for giving you access and credential to codebase. These variables should you keep:

Name Description
nexus_url URL for nexus artifact repository
nexus_username username account for the nexus
nexus_password password account for the nexus

After access are granted, you need to store it inside environment variables for security purposes.

like this:

environments

Using Hygen

Please prepare this data first before running the command:

  • Application Name, provide one word name with capitalized first character
  • Package Name, provide correct format package name
  • Codebase Version, which codebase version you want to use
  • Service Module, Do your application want to implement Service module as well?

Run the boilerplate template like this:

❯ hygen devbase new

You can paste the resulted project anywhere. You must build it once before run it because viewBinding is not yet included in the project.

Demo

You can follow this demo here for using the template.