Changeset - 6ef837acb0d2
[Not reviewed]
default
1 5 0
domruf - 8 years ago 2017-10-24 21:18:09
dominikruf@gmail.com
less: don't distribute the generated style.css file - for now, it must be built with npm after installing Kallithea

Generated files should not be included in the repository. Especially not when
using GPL with the requirement of distributing corresponding source.

Also add the two commands to generate the css file to the docs.

Modified by Mads Kiilerich.
6 files changed with 37 insertions and 1830 deletions:
0 comments (0 inline, 0 general)
.hgignore
Show inline comments
 
@@ -22,6 +22,7 @@ syntax: regexp
 
^\.project$
 
^\.pydevproject$
 
^\.coverage$
 
^kallithea/public/css/style\.css$
 
^kallithea\.db$
 
^test\.db$
 
^Kallithea\.egg-info$
docs/contributing.rst
Show inline comments
 
@@ -37,6 +37,8 @@ To get started with Kallithea developmen
 
        pip install --upgrade pip setuptools
 
        pip install --upgrade -e .
 
        pip install --upgrade -r dev_requirements.txt
 
        npm --prefix kallithea/public/less install     # install dependencies - both tools and data
 
        npm --prefix kallithea/public/less run less    # for generating css from less
 
        gearbox make-config my.ini
 
        gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
 
        gearbox serve -c my.ini --reload &
docs/overview.rst
Show inline comments
 
@@ -69,6 +69,12 @@ installed.
 
  (``pip install kallithea`` from a source tree will do pretty much the same
 
  but build the Kallithea package itself locally instead of downloading it.)
 

	
 
.. note:: The front-end code is built with Node. Currently, it must be built
 
          locally after installing Kallithea. Assuming Node and the Node
 
          Package Manager is available, other tools and source code will be
 
          downloaded and installed. The front-end code can then be built from
 
          source locally.
 

	
 

	
 
Web server
 
----------
docs/setup.rst
Show inline comments
 
@@ -5,6 +5,22 @@ Setup
 
=====
 

	
 

	
 
Preparing front-end
 
-------------------
 

	
 
Temporarily, in the current Kallithea version, some extra steps are required to
 
build front-end files:
 

	
 
Find the right ``kallithea/public/less`` path with::
 

	
 
    python -c "import os, kallithea; print os.path.join(os.path.dirname(os.path.abspath(kallithea.__file__)), 'public', 'less')"
 

	
 
Then run::
 

	
 
    npm --prefix kallithea/public/less install
 
    npm --prefix kallithea/public/less run less
 

	
 

	
 
Setting up Kallithea
 
--------------------
 

	
docs/upgrade.rst
Show inline comments
 
@@ -87,6 +87,18 @@ If you originally installed from version
 
    hg pull -u
 
    pip install --upgrade -e .
 

	
 
Temporarily, in the current version, an extra step is required to build
 
front-end files:
 

	
 
Find the right ``kallithea/public/less`` path with::
 

	
 
    python -c "import os, kallithea; print os.path.join(os.path.dirname(os.path.abspath(kallithea.__file__)), 'public', 'less')"
 

	
 
Then run::
 

	
 
    npm --prefix kallithea/public/less install
 
    npm --prefix kallithea/public/less run less
 

	
 

	
 
5. Upgrade your configuration
 
-----------------------------
kallithea/public/css/style.css
Show inline comments
 
deleted file
0 comments (0 inline, 0 general)