Development - sosik/registries GitHub Wiki

This page describes base information required for development.

Directory structure

src/ - sources for both client and server part
tests/ - all tests
build/ - build process creates and fills this directory by finally processed data or runtime environment

Prerequisites

You should have installed:
gem install sass

Checkout

After fresh checkout of repository you need to install required components. Do it by npm install and bower install. Those steps are required only immediately after checkout but prior first attempt to build project.

Build

Build system is based on grunt tool and all build configuration is defined in Gruntfile.js

To build sources execute grunt command without specifying task. To watch code changes as you develop you can use grunt watch command that watches for changes in source code and triggers build automatically.

Run

To execute server side code run command node build/server/server.js. Do not forget to build source code prior of running or use grunt watch task.

Commit

Prior commit of changes into repository run grunt mrpropper task to clean all unnecessary garbage from directory structure.