The KS (Knowledge Shaper) is a Document Automation digital product that enables the shaping and reuse of Knowledge Bases. Our effort is to allow and facilitate the creation of wizards that easily outputs documents just by answering to simple questions with an extra effort to a functiona design and UX.
You can try the demo online available on ks.studiolegale.it. Some example of Knowledge Bases are:
🚩 Table of Contents (click to expand)
🐳 Getting started
The easiest way to run ksweb is inside a docker container. just run
git clone --recursive https://github.com/puria/ksweb.git cd ksweb docker-compose up
For instructions about how to install
docker-compose please refere to the
💾 Manual Installation (for advanced users)
Checkout the project
git clone --recursive https://github.com/puria/ksweb.git
Before install KSweb you need to have an instance of
python3 >= 3.6 and
pip >= 18.1
run the installer:
brew install python3 cd ksweb ./install
apt install python3-dev python3-virtualenv cd ksweb ./install
ksweb using the setup.py script
# Enter into the first project folder $ cd ksweb # Create a virtual environment for python2 (important) $ virtualenv -p python2 venv # Activate your virtual environment (very important) $ source venv/bin/activate # Enter the subproject folder $ cd ksweb # Install all the dependencies $ pip install -e . # Populate the mandatory data (TO RUN JUST AT THE FIRST USAGE OF A DATABASE) $ gearbox setup-app
Start the http server
# Start a local webserver (NOT SUITABLE FOR PRODUCTION) $ gearbox serve --reload
Then you are ready to go
To run the webapp activate your virtualenv and run the server:
cd ksweb source venv/bin/activate gearbox serve
and head your browser to
Default accounts (username - password):
The conf files are
The most effective way is to edit the file and tweak stuff. Salient info are reported below.
The url of the database connection is
ming.url find it in
development.ini and change it per your needs.
The UI of the knowledge shaper is already translated in English and Italian. If you need othe languages, please indicate us someone who wants to help, and open and issue. The extensive documentation about how the translation works is available on this section of the Turbogears official site.
In briefe allows to:
- Create a new language (also called
- Extract the strings from the software
- Update and Compile existing language/catalog
The catalogs are simple
.po files that anyone can open with a translation
software (eg. Poedit)
🐛 Troubleshooting & debugging
To run the app in debug mode launch the server with the following flags
gearbox serve --debug --reload
Copyright (C) 2018 by StudioLegale.it http://studiolegale.it
Designed, written by AXANT.it and currently maintained by Puria Nafisi Azizi.
- FORK IT
- Create your feature branch
git checkout -b feature/branch
- Commit your changes
git commit -am 'Add some fooBar'
- Push to the branch
git push origin feature/branch
- Create a new Pull Request
- Thank you
Knowledge Shaper, Collaborative knowledge tools editor Copyright (c) 2017-TODAY StudioLegale.it <http://studiolegale.it> AXANT.it <http://axant.it> This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.