Clone the project

Summary

This page downloads the Dotkernel Frontend source code into an empty directory with git clone and shows the output to expect. It also recommends WSL2 as the development environment on Windows.

If you are using Windows as OS on your machine, you can use WSL2 as development environment. Read more here: Dotkernel development environment on WSL2

Using your terminal, navigate inside the directory you want to download the project files into.

Make sure that

  • The directory is empty before proceeding to the download process.
    • You will get this error if the directory is not empty fatal: destination path '.' already exists and is not an empty directory. and no files will be cloned.
  • That you have writing permissions on the directory.

Once there, run the following command:

git clone https://github.com/dotkernel/frontend.git .

If everything ran correctly, you can expect to see an output like this, though the numbers may differ.

Cloning into '.'...
remote: Enumerating objects: 6901, done.
remote: Counting objects: 100% (795/795), done.
remote: Compressing objects: 100% (343/343), done.
remote: Total 6901 (delta 522), reused 478 (delta 449), pack-reused 6106 (from 1)
Receiving objects: 100% (6901/6901), 3.83 MiB | 6.42 MiB/s, done.
Resolving deltas: 100% (3868/3868), done.

You can already open the project in your preferred IDE to double-check the files were copied correctly.

FAQ

Q: Why does the directory have to be empty?

A: Cloning into . fails with fatal: destination path '.' already exists and is not an empty directory. when the directory contains any files, and nothing is downloaded.

Q: Which branch does git clone install?

A: The default branch, 5.0, including changes that have not been released yet.

Q: I use Windows. What environment should I use?

A: WSL2, with one of the AlmaLinux distributions from dotkernel/development, as described in Running the Application.