##// END OF EJS Templates
rhodecode-enterprise-ce
RSS
api: cleanup sessions enforce older_then must be a valid INT.
api: cleanup sessions enforce older_then must be a valid INT.
marcink - - Load All Authors

File last commit:

r1215:b0ee4042 default
r1407:cbdeb872 default
Show More
dev-setup.rst
186 lines | 4.8 KiB | text/x-rst | RstLexer
/ docs / contributing / dev-setup.rst
History | Annotation | Raw |Copy content |Copy permalink

Development setup

RhodeCode Enterprise runs inside a Nix managed environment. This ensures build environment dependencies are correctly declared and installed during setup. It also enables atomic upgrades, rollbacks, and multiple instances of RhodeCode Enterprise running with isolation.

To set up RhodeCode Enterprise inside the Nix environment, use the following steps:

Setup Nix Package Manager

To install the Nix Package Manager, please run:

$ curl https://nixos.org/nix/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

Tip

Update your channels frequently by running nix-channel --upgrade.

Switch nix to the latest STABLE channel

run:

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

Followed by:

nix-channel --update

Install required binaries

We need some handy tools first.

run:

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

Clone the required repositories

After Nix is set up, clone the RhodeCode Enterprise Community Edition and RhodeCode VCSServer repositories into the same directory. To do this, use the following example:

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

Note

If you cannot clone the repository, please request read permissions via support@rhodecode.com

Install some required libraries

There are some required drivers 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:

sudo apt-get install libapr1-dev libaprutil1-dev
sudo apt-get install libsvn-dev
sudo apt-get install mysql-server libmysqlclient-dev
sudo apt-get install postgresql postgresql-contrib libpq-dev
sudo apt-get install libcurl4-openssl-dev

Enter the Development Shell

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

cd ~/rhodecode-enterprise-ce
nix-shell

Note

On the first run, this will take a while to download and optionally compile a few things. The following runs will be faster. The development shell works fine on both MacOS and Linux platforms.

Creating a Development Configuration

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

  1. Create a copy of ~/rhodecode-enterprise-ce/configs/development.ini
  2. Adjust the configuration settings to your needs

Note

It is recommended to use the name dev.ini.

Setup the Development Database

To create a development database, use the following example. This is a one time operation:

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

Compile CSS and JavaScript

To use the application's frontend and prepare it for production deployment, you will need to compile the CSS and JavaScript with Grunt. This is easily done from within the nix-shell using the following command:

grunt

When developing new features you will need to recompile following any changes made to the CSS or JavaScript files when developing the code:

grunt watch

This prepares the development (with comments/whitespace) versions of files.

Start the Development Server

From the rhodecode-vcsserver directory, start the development server in another nix-shell, using the following command:

pserve configs/development.ini http_port=9900

In the adjacent nix-shell which you created for your development server, you may now start CE with the following command:

rcserver dev.ini

Note

To automatically refresh - and recompile the frontend assets - when changes are made in the source code, you can use the option --reload.

Run the Environment Tests

Please make sure that the tests are passing to verify that your environment is set up correctly. RhodeCode uses py.test to run tests. While your instance is running, start a new nix-shell and simply run make test to run the basic test suite.

Need Help?

Join us on Slack via https://rhodecode.com/join or post questions in our Community Portal at https://community.rhodecode.com