Setup Nix Package Manager

To install the Nix Package Manager, please run:

$ curl https://releases.nixos.org/nix/nix-2.3.4/install | sh

or go to https://nixos.org/nix/ and follow the installation instructions. Once this is correctly set up on your system, you should be able to use the following commands:

• nix-env
• nix-shell

Switch nix to the latest STABLE channel

run:

nix-channel --add https://nixos.org/channels/nixos-20.03 nixpkgs

Followed by:

nix-channel --update
nix-env -i nix-2.3.4

Install required binaries

We need some handy tools first.

run:

nix-env -i nix-prefetch-hg
nix-env -i nix-prefetch-git

Speed up JS build by installing PhantomJS

PhantomJS will be downloaded each time nix-shell is invoked. To speed this by setting already downloaded version do this:

nix-env -i phantomjs-2.1.1

# and set nix bin path
export PATH=$PATH:~/.nix-profile/bin

Clone the required repositories

After Nix is set up, clone the RhodeCode Enterprise Community Edition and RhodeCode VCSServer repositories into the same directory. RhodeCode currently is using Mercurial Version Control System, please make sure you have it installed before continuing.

To obtain the required sources, use the following commands:

mkdir rhodecode-develop && cd rhodecode-develop
hg clone -u default https://code.rhodecode.com/rhodecode-enterprise-ce
hg clone -u default https://code.rhodecode.com/rhodecode-vcsserver

Install some required libraries

There are some required drivers and dev libraries that we need to install to test RhodeCode under different types of databases. For example in Ubuntu we need to install the following.

required libraries:

# svn related
sudo apt-get install libapr1-dev libaprutil1-dev
sudo apt-get install libsvn-dev
# libcurl required too
sudo apt-get install libcurl4-openssl-dev
# mysql/pg server for development, optional
sudo apt-get install mysql-server libmysqlclient-dev
sudo apt-get install postgresql postgresql-contrib libpq-dev

Enter the Development Shell

The final step is to start the development shells. To do this, run the following command from inside the cloned repository:

# first, the vcsserver
cd ~/rhodecode-vcsserver
nix-shell

# then enterprise sources
cd ~/rhodecode-enterprise-ce
nix-shell

Create config.nix for development

In order to run proper tests and setup linking across projects, a config.nix file needs to be setup:

# create config
mkdir -p ~/.nixpkgs
touch ~/.nixpkgs/config.nix

# put the below content into the ~/.nixpkgs/config.nix file
# adjusts, the path to where you cloned your repositories.

{
  rc = {
   sources = {
    rhodecode-vcsserver = "/home/dev/rhodecode-vcsserver";
    rhodecode-enterprise-ce = "/home/dev/rhodecode-enterprise-ce";
    rhodecode-enterprise-ee = "/home/dev/rhodecode-enterprise-ee";
   };
  };
}

Creating a Development Configuration

To create a development environment for RhodeCode Enterprise, use the following steps:

1. Create a copy of vcsserver config:

   cp ~/rhodecode-vcsserver/configs/development.ini ~/rhodecode-vcsserver/configs/dev.ini

2. Create a copy of rhodocode config:

   cp ~/rhodecode-enterprise-ce/configs/development.ini ~/rhodecode-enterprise-ce/configs/dev.ini

3. Adjust the configuration settings to your needs if needed.

rc-setup-app dev.ini \
    --user=admin --password=secret \
    --email=admin@example.com \
    --repos=~/my_dev_repos

make web-build

grunt watch

pserve configs/dev.ini

pserve --reload configs/dev.ini