angelmmiguel / kip

Knowledge is power

Kip

Kip is an open source Knowledge base for teams, because knowledge is Power. It's focused on writing, all team can write and edit the articles.

Features

• It's focused on writing. Start to write in one click.
• You don't need to register
• Markdown powered
• Powerful search in articles
• Highlight code snippets
• docker-compose ready
• Categories and authors are created on demand
• Store last 5 versions of the article (In progress)

Run Kip

You can install Kip in different ways. The easiest way is with docker-compose, but you can install it in a custom server. Kip only depends on mongodb and ruby.

To get more information, see Installation guide.

Demo

Do you want to see a demo of Kip and you have an account in Heroku? Click the following button :)

Screenshots

Welcome

More screenshots in the Wiki

Contributing

To contribute Kip:

• Create an issue with the contribution: feature, bug, enhancement...
• Fork the repository and make all changes you need
• Create a pull request when you finish

License

Kip is released under the MIT license. By Angelmmiguel (@irbrocks) ;)

kip's Issues

Include a delete button for Articles

Screenshots of README

Welcome

Write an article

Show an article

Index

Search functionality

We need to implement search in index view.

Improve code of Kip

We must add Rubocop, Brakeman and Flay to test suite. In addition we have some issues to solve from CodeClimate

Create a rake task for docker-compose to create mongodb indexes

Validate form when create or edit an article

Store last 5 versions of an article

It will be stored as embedded documents, see #3.

Revision

Name	Type
title	string
text	text
updated_by	string
created_at	datetime

Show changelog of a file

I think in a article, aside the author, it would be nice to show a list of users who have contributed to this article, not only the creator.

Create the logo

This will be a surprise... Knowledge is power.

Use Mongodb in the project

• Documentation of Mongoid gem
• Mongo introduction
• Mongo installation

Include tests for all functionalities

We need to include at least:

• Unit tests
• Controller tests
• Integration tests

Add tags to articles

Store the tags in a new column tags.

Suggest authors when write an article

The same for categories

Fix special characters in title

Use hard_wrap property of redcarpet

Test this option to prevent use a gsub after render with redcarpet

Create a view to read articles.

This view will follow the same principles of simplicity and vertical rhythm described in #6.

Blink effect scroll when write an article

When we are on the last line of the text, the scroll blink when we type.

Create an editor

The editor must be focused on content creation, so it won't have any distraction in the interface. In conclusion, the design will be clear.

We can check articles like Is Web Typography Completely Broken? or Why is Vertical Rhythm an Important Typography Practice? to create a nice environment to write.

Fix margin of pre when render an article

Add text indexes to search in articles

See Text Indexes in MongoDB

Incluye footer in show of articles

In addition, change the text of the footer from:

Made with (love) in Seville. This is an Open Source project.

to:

Made with (love) in Seville. Open Source project.

Create an index view

This view will list all available categories and a search box to find coincidences in titles and texts.

Add a footer

Include some info about the authors and the URL to the project.

Improve URL of articles

kip.me/articles/574d45143a39e5000c7d6e21 is too ugly :(. We can use an slug based on article title.

Create Article model

Every Article will have an existent Category. I create a Category model to improve its functionality in future releases.

Article

Name	Type
title	string
author	string
text	string
draft	boolean
category	string
versions	embedded documents (ArticleVersion)
collaborators	array of strings
created_at	datetime
updated_at	datetime

We can limit the number of versions, see Limit Number of Elements in an Array after an Update.

Author can't be modified after article creation.

Allow user to add a password to edit an article

This can be useful to prevent users to edit certain articles.

Save an article as draft

We can change the footer editor to display two buttons: Save as Draft and Publish. This add a label to the Article in index view.

Search does not return proper results

The search bar behavior is not the expected as it only returns results for some specific substrings of the article title / content.

Issue shown in the next gif:

Installation guide

Dockerize the app

Add Rspec to run tests

Add a welcome message

This message will introduce to Kip and invite the user to create the first article. It will showed when there isn't any Article.

Checkout Slate

I think is a good candidate for this application. We can think to move the project to React

https://github.com/ianstormtaylor/slate

Include a link icon in headers

This is useful to navigate to a section.

Include a library for external articles

External articles will be categorized and tagged too.

What do you think this library need?

Suggest categories when write an article

We can add a dropdown with current categories

Lists not render properly

I have an error when triying to render a list in an article. It's neccessary to include two break lines before a list. I point an example.

Line before list:
* List element 1
* List element 2

This piece of code doesn't render correctly the list. It's neccessary the above code:

Line before list:

* List element 1
* List element 2

Cache index page

This will improve performance. We can cache it until an article is updated.

Include images in articles

I think Drag and Drop is the best way to upload an image, but we can provide a button to include an image. We must think about it.

Include RedCarpet to render Markdown

Markdown is the selected format to write articles in Kip. RedCarpet gem.

Integrate with TravisCI

Allow users to edit articles

New users will be added to collaborators array.

Link in New Tab

I think when you click on a link is better to open a new tab, so it is not out of the web of Kip and you can continue reading the article easily when you return to visit the external web

Include a test about markdown rendering and ArticlesHelper

We must test security issue detected in #39

Increase margin between search results and call to action

Include categories in Articles

Create an index too:

index({ category: 1 }, unique: true, name: 'category_index')

Create Trash

When you delete an article, it isn't be deleted directly. It's moved to the trash and destroy after 30 days if nobody recover it.

Include a cheatsheet or markdown

We can add some markdown tags in placeholder and a link to a markdown help.

Add favicon

Cache Articles

We can cache the entire article until it's updated to prevent multiple Markdown renderizations.