blob: 9292a38579ff2822399d85e1f84201466bbbccf1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
<h1 id="developers-information">Developers information</h1>
<p>Do you want to help with making Chorus even better? Find help below...</p>
<p>This page contains information about getting your dev environment up and running so you can build and test your
changes without the hassle of setting up all the required dependencies.</p>
<h2 id="docker-dev-environment">Docker dev environment</h2>
<p>Included in this repo is a <code>Dockerfile</code> which builds the Chorus 2 dev environment image. If you wanted to develop
<em>without</em> using docker, this is a good reference as to what you need installed on your pc. </p>
<p>If you want to make your live much easier, just install docker then grab the pre-built image from docker hub.</p>
<pre><code>docker pull jez500/chorus2<span class="hljs-attribute">-dev</span>:latest
</code></pre><h3 id="installing-dev-dependencies">Installing dev dependencies</h3>
<p>Once you have the docker dev image, you can use this to do all your development related tasks. The first of these should
be installing all the nodejs/ruby dependencies.</p>
<pre><code>docker run <span class="hljs-attribute">-tiP</span> <span class="hljs-attribute">-v</span> <span class="hljs-string">`pwd`</span>:/app jez500/chorus2<span class="hljs-attribute">-dev</span>:latest <span class="hljs-built_in">.</span>/build<span class="hljs-built_in">.</span>sh install
</code></pre><p>This will run <code>npm install</code> and <code>bundle install</code> inside the dev container.</p>
<p>You should only need to do this once, unless... <code>package.json</code> or <code>Gemfile</code> are updated</p>
<h3 id="building-compiling-the-project">Building/Compiling the project</h3>
<p>If you have made changes to some coffee script or sass, you can build those changes via executing commands inside
the dev container. To get a command line in the container:</p>
<pre><code>docker run <span class="hljs-attribute">-tiP</span> <span class="hljs-attribute">-v</span> <span class="hljs-string">`pwd`</span>:/app jez500/chorus2<span class="hljs-attribute">-dev</span>:latest bash
</code></pre><p>Once inside the dev container, you can do the following:</p>
<h4 id="build">Build</h4>
<p>This will build languages, documentation, js and css.</p>
<pre><code>grunt build
</code></pre><h4 id="watch-for-changes-continuously-build-">Watch for changes (continuously build)</h4>
<p>This will only build js and css.</p>
<pre><code>grunt
</code></pre><h2 id="committing-your-changes">Committing your changes</h2>
<p>As a rule of thumb, you should not commit any compiled files unless you are building a release. Eg. only commit files
in the <code>src</code> folder.</p>
|
