Skip to main content

Overview

SOKit Initializer​

The SOKit Initializer is a tool that helps you create a new SOKit application quickly using predefined templates. It simplifies the setup process and ensures your project follows standard conventions from the start.

⚙️ Set Up the Initializer​

To get started, clone the SOKit templates registry repository:

git clone [email protected]:strategyobject/sokit/sokit-templates/registry.git

Configure Environment Variables​

Set the required environment variables for accessing the SOKit package and template registries:

export SO_REGISTRY_URL="registry.gitlab.com"
export SO_REGISTRY_CRED_NAME=[]
export SO_REGISTRY_CRED_VALUE=[]

export SO_REPOSITORY="https://gitlab.com/api/v4/projects/56940841/packages/maven"
export SO_REPOSITORY_CRED_NAME=[]
export SO_REPOSITORY_CRED_VALUE=[]

Make sure to replace the empty brackets [] with the appropriate credentials provided by your team.

Run the Development Environment​

Ensure Docker is installed and running on your machine (refer to the Requirements section if needed). Then, follow these steps:

1. Modify Your Hosts File​

Update your /etc/hosts file to route the development domain to localhost:

127.0.0.1   localhost dev.strategyobject.com
::1         localhost dev.strategyobject.com

2. Start the Services​

Navigate to the cloned registry directory and run:

docker compose up -d

This command starts the SOKit Initializer and all required services in detached mode.

3. Stop the Services​

To shut down the environment, use:

docker compose down

Once started, the environment will include several key services including the SOKit Initializer and Keycloak.

Accessing Keycloak (Development Environment)​

Keycloak is used for identity and access management during development.

To access the Keycloak admin console, open your browser and navigate to:

http://dev.strategyobject.com:6060/admin/master/console/

You will see the Keycloak login screen:

Keycloak Login

Admin Credentials​

Use the predefined credentials:

  • Username: kc
  • Password: kc123

Once logged in, you will land in the master realm.

View Users​

  • Click on Users in the left-hand menu.
  • The default user kc will be listed under the master realm.

Keycloak Home

Switch to the dev Realm​

  • Click the realm dropdown at the top-left and select dev.

Keycloak Realm

  • Then click Users in the left menu.
  • You will see the predefined users: alice and bob.

Keycloak Users

This concludes the setup and initial usage of the SOKit Initializer and Keycloak. These tools will be used more extensively during the application development process.