DEV Community: Daniel Polito

The Kool Way to Run Hugo Static Sites on Docker

Daniel Polito — Tue, 27 Jul 2021 16:02:53 +0000

In just 2 simple steps, you can use Kool to start a new Hugo application running in a local Docker development environment.

Kool is a free, open source CLI tool that makes local development with Docker super easy. Kool CLI will level up your development workflow, and help you and your team improve the way you develop and deploy cloud native applications.

Requirements

If you haven't done so already, you first need to install Docker and the Kool CLI.

If you already have kool installed, make sure you're running the latest version with kool self-update.

Step 1 – Create a New Hugo Application

Use the kool create command to create your new Hugo project.

$ kool create hugo my-project

IMPORTANT: if you're on Windows WSL or Linux, you should run sudo kool create hugo my-project as the superuser (via sudo) to avoid permissions issues when creating the project directory and files.

Under the hood, this command will run kool docker klakegg/hugo:ext-alpine new site my-project using the klakegg/hugo Docker image.

Now, move into your new Hugo project:

$ cd my-project

After installing Hugo, kool create automatically runs the kool preset hugo command, which auto-generates the following configuration files and adds them to your project. As your project evolves, you can easily modify and extend these files to suit your needs.

+docker-compose.yml
+kool.yml

Step 2 – Start Your Local Environment

As mentioned above, the kool preset command added a kool.yml file to your project. To help get you started, kool.yml comes prebuilt with an initial set of scripts based on your chosen framework and stack. Since Hugo requires a few extra steps to create a Hello World site, kool.yml includes a special quickstart script to make it super easy.

Think of kool.yml as an easy-to-use task helper. Instead of writing custom shell scripts, add your own scripts to kool.yml (under the scripts key), and run them with kool run SCRIPT (e.g. kool run hugo). You can add your own single line commands (see hugo below), or add a list of commands that will be executed in sequence (see quickstart below).

scripts:
    hugo: kool docker -p 1313:1313 klakegg/hugo:ext-alpine
    dev: kool run hugo server -D

    # remove or modify to suit the needs of your project
    quickstart:
        - kool start
        - git init
        - git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
        - echo theme = \"ananke\" >> config.toml
        - kool run hugo new posts/my-first-post.md
        - kool run dev

    setup:
        - kool start
        - kool run dev

Go ahead and run kool run quickstart to start your Docker environment and initialize your Hugo site.

$ kool run quickstart

As you can see in kool.yml, the quickstart script does the following in sequence: runs the kool start command to spin up your Docker environment; calls git init to create a Git repository; downloads the Ananke theme; uses an echo command to add the theme to your Hugo config file; adds your first post; and then calls kool run dev to build your Hugo site.

That's it!

Once kool run quickstart finishes, you should be able to access your new site at http://localhost and see the "My New Hugo Site" page. Hooray!

Verify your Docker service containers are running using the kool status command.

$ kool status
+---------+---------+------------------------------+--------------+
| SERVICE | RUNNING | PORTS                        | STATE        |
+---------+---------+------------------------------+--------------+
| app     | Running | 0.0.0.0:80->80/tcp, 1313/tcp | Up 2 minutes |
| static  | Running | 80/tcp                       | Up 2 minutes |
+---------+---------+------------------------------+--------------+

Run kool logs app to see the logs from your running app container.

Use kool logs to see the logs from all running containers. Add the -f option after kool logs to follow the logs (i.e. kool logs -f app).

$ kool logs app
Attaching to my-project_app_1
app_1     |   Non-page files   |  0
app_1     |   Static files     |  0
app_1     |   Processed images |  0
app_1     |   Aliases          |  0
app_1     |   Sitemaps         |  1
app_1     |   Cleaned          |  0
app_1     |
app_1     | Built in 1 ms
app_1     | Watching for changes in /app/{archetypes,content,data,layouts,static}
app_1     | Watching for config changes in /app/config.toml
app_1     | Environment: "DEV"
app_1     | Serving pages from memory
app_1     | Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
app_1     | Web Server is available at http://localhost:80/ (bind address 0.0.0.0)
app_1     | Press Ctrl+C to stop
app_1     |
app_1     | Change of config file detected, rebuilding site.
app_1     | 2021-05-01 20:34:06.306 +0000
app_1     | Rebuilt in 136 ms
app_1     | adding created directory to watchlist /app/content/posts
app_1     |
app_1     | Change detected, rebuilding site.
app_1     | 2021-05-01 20:34:07.305 +0000
app_1     | Source changed "/app/content/posts/my-first-post.md": CREATE
app_1     | Total in 26 ms

When it's time to stop working on the project:

$ kool stop

When you're ready to start coding again:

$ kool start

If you like what we're doing, show your support for this new open source project by starring us on GitHub!

Level Up Your Development Workflow

Once you're up and running with your new Hugo project, you can use the kool CLI to level up your development workflow. Learn more in "How It Works".

Support the Kool Open Source Project

Kool is open source and totally free to use. If you're interested in learning more about the project, please check out kool.dev. If you have questions, need support, or want to get involved, please join our Slack channel.

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About `kool`

Kool is a CLI tool that brings the complexities of modern software development environments down to earth - making these environments lightweight, fast and reproducible. It reduces the complexity and learning curve of Docker containers for local environments, and offers a simplified interface for using Kubernetes to deploy staging and production environments to the cloud.

Kool gets your local development environment up and running easily and quickly, so you have more time to build a great application. When the time is right, you can then use Kool.dev Cloud to deploy and share your work with the world!

Kool is suitable for solo developers and teams of all sizes. It provides a hassle-free way to handle the Docker basics and immediately start using containers for development, while simultaneously guaranteeing no loss of control over more specialized Docker environments.

Learn more at kool.dev.

Installation

Requirements: Kool is powered by…

View on GitHub

Running NestJS on Docker is Really Easy with Kool

Daniel Polito — Mon, 19 Jul 2021 20:33:49 +0000

In just 3 simple steps, you can use Kool to start a new NestJS application running in a local Docker development environment.

Kool is a free, open source CLI tool that makes local development with Docker super easy. Kool CLI will level up your development workflow, and help you and your team improve the way you develop and deploy cloud native applications.

Requirements

If you haven't done so already, you first need to install Docker and the Kool CLI.

If you already have kool installed, make sure you're running the latest version:

$ kool self-update

Step 1 – Create a New NestJS Application

Use the kool create command to create your new NestJS project.

$ kool create nestjs my-project

Under the hood, this command will run nest new my-project to install NestJS using a customized Kool Docker Image: kooldev/node:14-nest.

Learn more about Kool Docker Images in our article "Use Kool to Dockerize Your Local Development Environment the Right Way".

After installing NestJS, kool create automatically runs the kool preset nestjs command, which helps you set up the initial tech stack for your project using an interactive wizard.

$ Preset nestjs is initializing!

? Which database service do you want to use [Use arrows to move, type to filter]
> MySQL 8.0
  MySQL 5.7
  PostgreSQL 13.0
  none

? Which cache service do you want to use [Use arrows to move, type to filter]
> Redis 6.0
  Memcached 1.6
  none

? Which package manager did you choose during Nest setup [Use arrows to move, type to filter]
> npm
  yarn

$ Preset nestjs initialized!

Now, move into your new NestJS project:

$ cd my-project

The kool preset command auto-generated the following configuration files and added them to your project, which you can easily modify and extend to suit your needs.

+docker-compose.yml
+kool.yml

Step 2 (Optional) – Add Environment Variables

You can skip this step if you did not add a database or cache service to your project via the wizard.

If you added a database and/or cache service, you'll need to add some local environment variables to match the services in your docker-compose.yml file (see below). For example, you'll need to change the hosts from localhost to the appropriate service container name, which are accessible from within Docker.

Create a .env file inside your project's root directory, and add the appropriate environment variables to this file (as provided below) based on the services used in your project.

Learn more about how to configure NestJS.

Database Services

MySQL 5.7 and 8.0

+DB_CONNECTION=mysql
+DB_HOST=database
+DB_DATABASE=<some_database_name>
+DB_USERNAME=<some_username>
+DB_PASSWORD=<some_password>

PostgreSQL 13.0

+DB_CONNECTION=pgsql
+DB_HOST=database
+DB_PORT=5432
+DB_DATABASE=<some_database_name>
+DB_USERNAME=<some_username>
+DB_PASSWORD=<some_password>

Cache Services

Redis

+REDIS_HOST=cache
+REDIS_PORT=6379

Memcached

+MEMCACHED_HOST=cache
+MEMCACHED_PORT=11211

Step 3 – Start Your Local Environment

Now, spin up your local environment for the first time using the setup script in your kool.yml file:

$ kool run setup

npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@~2.3.1 (node_modules/chokidar/node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.3.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

audited 879 packages in 32.143s

78 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

Creating network "my-project_kool_local" with the default driver
Creating volume "my-project_database" with default driver
Creating volume "my-project_cache" with default driver
Creating my-project_database_1 ... done
Creating my-project_app_1      ... done
Creating my-project_cache_1    ... done

That's it!

Once kool run setup finishes, you can access your new NestJS app at http://localhost:3000 and see the NestJS "Hello World!" welcome page.

Level Up Your Workflow

Now that you have your new NestJS app up and running, you can use the Kool CLI to start leveling up your development workflow.

Add Scripts to kool.yml

Think of kool.yml as a super easy-to-use task helper. Instead of writing custom shell scripts, you can add your own scripts to kool.yml (under the scripts key), and run them with kool run SCRIPT. You can add single line commands (kool run nest), or add a list of commands that will be executed in sequence (kool run setup). For example, add scripts to run database migrations, reset local environments, run static analysis tools, and so on. Think about how much easier it will be to onboard a teammate or new developer :)

scripts:
  mysql: kool exec -e MYSQL_PWD=$DB_PASSWORD database mysql -u $DB_USERNAME $DB_DATABASE # or psql for PostgreSQL
  nest: kool exec app nest
  npm: kool exec app npm # or yarn
  npx: kool exec app npx

  setup:
    - kool docker kooldev/node:14 npm install # or yarn install
    - kool start

Run Commands

When you need to execute a command inside a running service container, use the kool exec command. Run the following to check the version of Node running in your app container.

$ kool exec app node -v

v14.17.1

Connect to the Database

If you added a database service, start a new SQL client session inside your running database container by executing kool run mysql (MySQL) or kool run psql (PostgreSQL). This runs the mysql or psql script in your kool.yml.

Add Dependencies

As your project evolves, and you add more dependencies to package.json, use the kool restart command to restart your app container and load the new packages.

$ kool restart app

Stopping my-project_app_1 ... done
Going to remove my-project_app_1
Removing my-project_app_1 ... done
Creating my-project_app_1 ... done

View the Logs

View container logs using the kool logs command. Run kool logs to see the logs for all running containers, or kool logs app to specify a service and only see the logs for the app container. Add the -f option after kool logs to follow the logs (i.e. kool logs -f app).

Share Your Work

When you need to quickly share local changes with your team, use the kool share command to share your local environment over the Internet via an HTTP tunnel. Specify your own subdomain using the --subdomain flag.

$ kool share --port=3000

Thank you for using expose.
Local-URL:     app:3000
Dashboard-URL: http://127.0.0.1:4040
Expose-URL:    https://eeskzijcbe.kool.live

Remaining time: 00:59:59
Remaining time: 00:59:58
Remaining time: 00:59:57

Switch Projects

Kool supports any language or framework, so you can standardize the way you work across all your tech stacks. When it's time to stop working on your new NestJS app and switch to a different project, you can easily change local Docker environments by running kool stop on the NestJS project, moving into the other project directory, and running kool start.

$ kool stop
$ cd ~/my-other-project
$ kool start

Pretty kool, right?

If you like what we're doing, show your support for this new open source project by starring us on GitHub!

Dive Deeper

Read the docs for our NestJS Preset to learn more about using Kool with NestJS.
Check out the Kool Presets for other popular frameworks.
Go to kool.dev to learn more about the Kool open source project.

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About `kool`

Learn more at kool.dev.

Installation

Requirements: Kool is powered by…

View on GitHub

Running Laravel on Docker is really easy with Kool

Daniel Polito — Tue, 22 Jun 2021 18:31:04 +0000

In just 3 simple steps, you can use Kool CLI's kool create command to start a new Laravel application running in a local Docker environment. Kool is an open source dev tool that makes using Docker for local development a lot easier.

Before you start, if you haven't done so already, you need to install Docker and Kool CLI.

1. Create a new Laravel application

$ kool create laravel my-project

This command may take a minute or two to complete while Composer downloads Laravel's vendor dependencies. After installing Laravel, kool create automatically runs the kool preset laravel command, which helps you set up your project's development environment using an interactive wizard.

PHP

? What app service do you want to use  [Use arrows to move, type to filter]
> PHP 8.0
  PHP 7.4

Database

? What database service do you want to use  [Use arrows to move, type to filter]
> MySQL 8.0
  MySQL 5.7
  MariaDB 10.5
  PostgreSQL 13.0
  none

Cache

? What cache service do you want to use  [Use arrows to move, type to filter]
> Redis 6.0
  Memcached 1.6
  none

Package Manager

? What javascript package manager do you want to use  [Use arrows to move, type to filter]
  npm
> yarn

After selecting your preferences, the latest version of Laravel will be installed and ready for you in your my-project folder, along with your new kool environment.

Move into your new Laravel project:

$ cd my-project

The kool preset command auto-generated the following configuration files and added them to your project, which you can modify and extend.

+docker-compose.yml
+kool.yml

2. Update `.env.example`

Next, we need to make a few tweaks to the default .env.example file that ships with Laravel in order to match the services in your docker-compose.yml file. For example, we need to change the hosts from localhost to the appropriate service container name, which are accessible from within Docker.

Database Services

MySQL 5.7 and 8.0 / MariaDB 10.5

-DB_HOST=127.0.0.1
+DB_HOST=database

PostgreSQL 13.0

-DB_CONNECTION=mysql
+DB_CONNECTION=pgsql

-DB_HOST=127.0.0.1
+DB_HOST=database

-DB_PORT=3306
+DB_PORT=5432

Cache Services

Redis

-REDIS_HOST=127.0.0.1
+REDIS_HOST=cache

Memcached

-MEMCACHED_HOST=127.0.0.1
+MEMCACHED_HOST=cache

3. Run `kool run setup`

Now, spin up your local environment for the first time using the setup script in your kool.yml file:

$ kool run setup

Note: if you're running this command for the first time, Docker may need to download all the container images that are being used, which can take a few minutes, depending on your internet connection.

That's it!

After kool run setup has finished, you can access your new Laravel app at http://localhost.

$ kool run setup

Creating network "my-project_kool_local" with the default driver
Creating volume "my-project_database" with default driver
Creating volume "my-project_cache" with default driver
Creating my-project_cache_1    ... done
Creating my-project_app_1      ... done
Creating my-project_database_1 ... done

Dive Deeper

Read the docs for our Laravel Preset to learn more about using Kool with Laravel.
Go to kool.dev to learn more about the Kool open source project.

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About `kool`

Learn more at kool.dev.

Installation

Requirements: Kool is powered by…

View on GitHub

DEV Community: Daniel Polito

The Kool Way to Run Hugo Static Sites on Docker

Requirements

Step 1 – Create a New Hugo Application

Step 2 – Start Your Local Environment

Level Up Your Development Workflow

Support the Kool Open Source Project

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About kool

Installation

Running NestJS on Docker is Really Easy with Kool

Requirements

Step 1 – Create a New NestJS Application

Step 2 (Optional) – Add Environment Variables

Database Services

Cache Services

Step 3 – Start Your Local Environment

Level Up Your Workflow

Add Scripts to kool.yml

Run Commands

Connect to the Database

Add Dependencies

View the Logs

Share Your Work

Switch Projects

Dive Deeper

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About kool

Installation

Running Laravel on Docker is really easy with Kool

1. Create a new Laravel application

PHP

Database

Cache

Package Manager

2. Update .env.example

Database Services

Cache Services

3. Run kool run setup

Dive Deeper

kool-dev / kool

From local development to the cloud: web apps development with containers made easy.

About kool

Installation

About `kool`

About `kool`

2. Update `.env.example`

3. Run `kool run setup`

About `kool`