Local development

gws uses minikube and kubernetes for local development.

Workspace

In order to be able to start a getwebstack project locally, you first need to set up a workspace. By default, when you initialise or clone a new project a workspace is automatically generated in the parent folder of the project.

All workspaces will be mounted in the local cluster.

See more commands which are available for workspaces

Cluster

The cluster used locally by getwebstack is a kuberneties cluster which is automatically configured according to the setup of the components.

You can use gws to get the status and logs of the components. You can also use both kubectl and minikube to manage the cluster.

Status

You can get the status of the deployment to the local cluster of a component by using the following:

gws component status COMPONENT_NAME

You can check the status of all the components inside a project using:

gws project status PROJECT_NAME

You can also check the status of the cluster with:

gws cluster status

Logs

You can see the logs at cluster, project, bundle or component level.

# Component level
gws component logs COMPONENT_NAME

# Aggregated per bundle
gws bundle logs BUNDLE_NAME

# Aggregated per project
gws project logs PROJECT_NAME

# All the logs in the local cluster
gws cluster logs

Debugging

In order to access the ip and port used for debugging a component you can use the following:

gws component COMPONENT_NAME debug