Set up local environment
This quick start will install the cables dev environment for you, and all that is needed to start making changes to cables.
The setup relies on the bash shell, which should be present on osx and linux, and
we will install it on windows. You should be somewhat familiar with working with nodejs, but we
will guide you as much as possible.
In these steps we will clone the cables default repositories, once that is done, you can start working with your fork,
if you created one.
The scripts included in these steps and this repository are described in a separate document.
But let's get started:
Mac/Linux
- install git
- clone this repository
- change into the checked out directory (
cd cables_dev/
) - continue below
Windows 10/11
- install and start Visual Studio Code
- install git (
Ctrl-Shift-G
,Download Git for Windows
), download, install (make sure to installGit Bash
as well), restartVisual Studio Code
- clone this repository from GitHub (
Ctrl-Shift-G
,Clone Repository
,Clone from GitHub
) - open new terminal (
Ctrl-Shift-`
), make sure it'sGit Bash
, notPowerShell
- make sure you have a profile file for your shell
touch ~/.bash_profile
- continue below
Common
- install Node Version Manager
- close and reopen your terminal, make sure nvm is installed properly,
nvm --version
should output some version number - run
./install_local.sh
- this will:
- install the required node version (and set it as default in
nvm
) - check out all needed repositories into subdirectories
npm install
all dependenciesnpm run build
in all repositories
- install the required node version (and set it as default in
- this will:
- IMPORTANT: make sure your current shell has the proper node version by running
node --version
before the next step- if not, open a new terminal before you start the server, and check again
- change directory to
cables_electron/
- continue with the cables electron development steps
- if you forked any of the above repos, check out how to work with forks
Found a problem? Edit this file on github and contribute to cables!