Repository files navigation

TheKS (Knowledge Shaper) is aDocument 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 onks.studiolegale.it.Some example of Knowledge Bases are:

• Memorandum on GDPR compliance
• Lawyer quotation (in italian)

The easiest way to run ksweb is inside a docker container. just run

git clone --recursive https://github.com/puria/ksweb.gitcd kswebdocker-compose up

For instructions about how to installdocker-compose please refere to theofficial documentation

Checkout the project

git clone --recursive https://github.com/puria/ksweb.git

Before install KSweb you need to have an instance of🍃mongodb up and running, thepython development headers andpython3-virtualenv packagesNB you needpython3 >= 3.6 andpip >= 18.1

You also need to have to installpandoc for exporting the actual output to different formats.

run the installer:

🍎 macosx

brew install python3cd ksweb./install

🐧 debian derivatives

apt install python3-dev python3-virtualenvcd ksweb./install

Installksweb 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 kswebsource venv/bin/activategearbox serve

and head your browser tohttp://localhost:8080

Default accounts (username - password):

Administrator: admin 🔑 adminks

Lawyer: lawyer 🔑 lawyerks

User: user 🔑 userks

The conf files aredevelopment.ini andtest.ini.

The most effective way is to edit the file and tweak stuff. Salient info are reported below.

The url of the database connection isming.url find it indevelopment.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, andopen and issue.The extensive documentation about how the translation works is available onthis sectionof the Turbogears official site.

In briefe allows to:

• Create a new language (also calledCatalog)
• Extract the strings from the software
• Update and Compile existing language/catalog

The catalogs are simple.po files that anyone can open with a translationsoftware (eg.Poedit)

To run the app in debug mode launch the server with the following flags

gearbox serve --debug --reload

Copyright (C) 2018 by StudioLegale.ithttp://studiolegale.it

Designed, written by AXANT.it and currently maintained by Puria Nafisi Azizi.

1. FORK IT
2. Create your feature branchgit checkout -b feature/branch
3. Commit your changesgit commit -am 'Add some fooBar'
4. Push to the branchgit push origin feature/branch
5. Create a new Pull Request
6. Thank you

Knowledge Shaper, Collaborative knowledge tools editorCopyright (c) 2017-TODAY StudioLegale.it <http://studiolegale.it>                         AXANT.it <http://axant.it>This program is free software: you can redistribute it and/or modifyit under the terms of the GNU Affero General Public License aspublished by the Free Software Foundation, either version 3 of theLicense, 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See theGNU Affero General Public License for more details.You should have received a copy of the GNU Affero General Public Licensealong with this program.  If not, see <http://www.gnu.org/licenses/>.