Set up for Kitematic developmentEstimated reading time: 4 minutes
Kitematic is built on top of:
Download and install NVM
To get started, you will need to install Node.js v4.2.1. Using Node Version Manager (NVM) makes the Node.js install easy.
Download latest release.
Follow the installer steps to get NVM installed. Please note, you need to uninstall any existing versions of node.js before installing NVM for Windows; the above installer link will have an uninstaller available.
Open a terminal window.
Copy and paste the following install script:
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash
To activate nvm, close the terminal window and re-open a new one.
(Alternatively, you can source nvm from your current shell with the command
Install the proper Node.js version.
$ nvm install v4.2.1
Make this version the default.
$ nvm alias default v4.2.1
node --versionto confirm that you are now using the proper Node.js version.
$ node --version
Fork the master branch of Kitematic
To fork the master branch of Kitematic:
Go to the docker/kitematic repository .
Click Fork in the upper right corner of the GitHub interface.
GitHub forks the repository to your GitHub account. The original
docker/kitematicrepository becomes a new fork
YOUR_ACCOUNT/kitematicunder your account.
Copy your fork’s clone URL from GitHub.
GitHub allows you to use HTTPS or SSH protocols for clones. You can use the
gitcommand line or clients like Subversion to clone a repository. This guide assumes you are using the HTTPS protocol and the
gitcommand line. If you are comfortable with SSH and some other tool, feel free to use that instead. You’ll need to convert what you see in the guide to what is appropriate to your tool.
Clone your repository locally and create a branch
To clone your repository and create a branch for the issue:
Open a terminal window on your local host and change to your home directory.
$ cd ~
In Windows, you’ll work in your Docker Quickstart Terminal window instead of Powershell or a
Create a directory for your new repository and change into that directory.
From the root of your repository, clone the fork to your local host.
$ git clone https://github.com/YOUR_USERNAME/kitematic.git
Create and checkout a branch for the issue you will be working on.
$ git checkout -b 1191-branch
As previously mentioned, issue #1191 is set up as an example to use for this exercise.
Set up your signature and upstream remote
You can set your signature globally or locally.
user.namefor the repository.
$ git config --local user.name "FirstName LastName"
user.emailfor the repository.
$ git config --local user.email "firstname.lastname@example.org"
Check the result in your
$ git config --local --list
Set your local repository to track changes upstream, on the
$ git remote add upstream https://github.com/docker/kitematic.git
(To learn more, see Set up your signature and an upstream remote.)
Install dependencies, start Kitematic, and verify your setup
Your Node.js install includes npm for package management. You’ll use it to install supporting packages and start the app.
Verify that the package manager is running and check the version (at the time of this writing, v2.14.7).
$ npm --version
Install the package dependencies.
$ npm install
From the root of your kitematic repository, use the package manager to start Kitematic and confirm everything went well.
$ npm start
All of the core files in Kitematic are in the
src folder, which then
follows the AltJS structure of:
kitematic/ |--src/ |--actions/ | |--MyActions.js |--stores/ | |--MyStore.js |--components/ | |--MyComponent.react.js
components folder is where the layout files are, the
stores represent the application logic, and
actions are the dispatcher for actions taken within the
Where to go next
You are ready to start working on the issue. Go to Develop in Kitematic (work on an issue).Kitematic, open source, contribute, contributor, tour, development