Skip to content

Commit

Permalink
README.rst: Add Build and Development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
KVGarg committed Jan 13, 2019
1 parent ae06441 commit c87bb33
Showing 1 changed file with 68 additions and 2 deletions.
70 changes: 68 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,74 @@ We appreciate any help!
BUILD & DEVELOPMENT
-------------------

Run ``python3 setup.py install``
1. Clone the *coala-html* repository

Note: You need to have bower installed before you may install the python packages.
::

$ git clone https://github.com/coala/coala-html.git

2. Install latest version of **Node.js**

- *Configure Node.js PPA*

::

$ sudo apt-get install curl python-software-properties
$ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -

- *Install Node.js and npm*

::

$ sudo apt-get install nodejs

- *Check Node.js and npm version*

You can find more details about current version on node.js `official website
<https://nodejs.org/>`__.

::

$ node -v
v11.6.0

$ npm -v
6.5.0

3. Install **bower** to build static web pages

::

$ sudo npm install -g bower

4. Change the directory to *coala-html* and run following command to install dependencies

::

$ python setup.py install

5. Install **coala-bears**

::

$ pip install coala-bears

6. Allow permissions to **root user** to install node packages

::

$ sudo chown -R $USER:$GROUP ~/.npm
$ sudo chown -R $USER:$GROUP ~/.config
$ sudo chown -R $USER:$GROUP ~/.cache/bower/registry/registry.bower.io/lookup/
$ sudo chown -R $USER:$GROUP ~/.cache/bower/packages

7. Run **coala-html** to display results from *coala-json*

::

$ coala-html --dir ..\Tests

For more usage details, refer to the usage_ section.

LICENSE
=======
Expand All @@ -93,3 +158,4 @@ your option) any later version.
:target: https://codecov.io/github/coala/coala-html?branch=master
.. _GIF: https://cloud.githubusercontent.com/assets/7397433/16225501/8162a2a4-37c4-11e6-96b8-3e37b705c7f3.gif
.. _Live: http://coala.github.io/coala-html
.. _usage: https://github.com/KVGarg/coala-html/tree/build_development_instructions#usage

0 comments on commit c87bb33

Please sign in to comment.