KIP

KIP (standing as Knowledge Is Power) is a dead simple yet beautiful knowledge base management based on markdown files 🔥

@TODO put a screenshot / live demo link when the new style will be implemented

Purpose
Features
Requirements
Installation
Getting started
Contribute
Licence

Purpose

We spent many hours searching for a Knowledge Base ('KB') to fill all our needs, and after maybe 15 or more KB solutions tested, paid or free, open source or not, we never found something that really rocks for us. That's why @decima took the lead to create a killer KB from scratch ! 💥

Features

👀 A nice and modern interface to read articles (who reads ugly articles, right ?)
📂 An easy way to import / export data from it : it simply reads a folder containing all your markdown files, CAN'T BEAT THAT
✏️ A good markdown editor
🙅 Access management : being able to edit articles only when logged in
🔍 A powerful search engine
🔒 Database / LDAP authentication

Requirements

This project is a symfony project and requires PHP >= 7.4
node and npm or yarn to build asset files

Installation

You should run these commands in a terminal :

git clone https://github.com/AboutGoods/kip.git
cd kip
composer install
yarn # or `npm install` if you are using npm

Feel free to change environment variables by copying the .env file to a .env.local file.

And you're good to go ! 🎉

For more installation options and configurations, please check INSTALL.md

Getting started

Your markdown files should be placed in the folder specified in the FILE_STORAGE environment variable (by default in ./var/storage). There already is a starter file for you to start writing !

Using a local stack

To run the project in development, you should run these commands in parallel :

php -S 0.0.0.0:8000 -t public # this serves the specified folder as the root of the KB
yarn dev-server # or `npm run dev-server` - builds style and script files to the `public` folder

Using Docker

For those who don't want to install php on their computer, you can use a pre-built docker-image for development.

Using docker-compose, it will start the project on port 8010 by default and use the var/storage folder for markdown files :

docker-compose up

Contribute

🙌 Every contributions, even small are welcome, feel free to make this project awesome 💫

Make sure to follow the instructions in CONTRIBUTING.md

Licence

Defining it soon (@TODO)

decima/kip

KIP