Git Product home page Git Product logo

QKspace Logo

QKspace (pronounced "quick space") is a minimalistic knowledge base for small teams.

It is perfect for creating a course reference base for an educational organisation, for making a QnA list in the IT, for exchanging knowledge within social work teams, for making a thematic list of personal quotes and notes.

Usage examples

A list of guidelines for Ruby newbies: http://ruby.qkspace.com

Information about the law of renovation in Moscow: http://renovation.qkspace.com/

Lovecraft quotes: http://lovecraft.qkspace.com

Features

  • Creating projects with a number of pages
  • Markdown user-friendly editor
  • Adding your own domain
  • Collaborative project editing
  • Private and public projects

How to contribute

The project is run by a non-profit community of developers.

The list of bugs and issues is here: https://github.com/issues

Feel free to send your PRs. If the task isn’t closed, it still needs to be done.

Use chat for support and general questions.

Contacts

For all questions please contact us at [email protected]

Regarding commercial collaboration please contact us at [email protected]

Developers

Vadim Venediktov
Eugene Zolotarev
Aleksander Klimenkov
Dmitry Smirnov
Igor Stroganov
Dmitry Malyshev
Alexander Vladimirov

The developers' contributions are listed on the corresponding page.

License

MIT.

See LICENSE for full text.

See THIRDPARTY-LICENSES for third-party licenses' texts.

This background of this image is courtesy NASA/JPL-Caltech.

Launching

Download or clone repo.

Use bundler

bundle install

Run database migrations

rails db:migrate

Fill development database with some test data

rails db:seed

Launch Rails server

rails s

Open http://localhost:3000 in your browser

Enter your email address in the input field (the user email from the seed is [email protected]).

Copy the sign in link from the server console and follow this link. Example: (http://localhost:3000/sign_in/uR7S9GVX50Et6EMCMJ7MP2jPeCamf31USWKUSfEabEM)

Go to private page http://localhost:3000/projects

To visit public pages on subdomains on your local machine you need to update your /etc/hosts file, adding the needed subdomain. For example:

sudo nano /etc/hosts add 127.0.0.1 test.qkspace.localhost:3000

Go to public page and check: http://test.qkspace.localhost:3000/qkspace-test-project

Installation

Install ImageMagick on Ubuntu

sudo apt-get install imagemagick
sudo apt-get install libmagickcore-6.q16-dev

Install Redis

on development(local) Ubuntu

  • sudo apt-get install redis-server

Check installation

  • redis-server -v

on production(remote) Ubuntu

  • sudo apt-get install redis-server

  • And add Redis to autoload

    • sudo systemctl enable redis-server

Check installation

sudo systemctl start redis
sudo systemctl status redis

Running Sidekiq in production using Systemd

To setup a Sidekiq Systemd service, you need a service configuration file. An example file can be found in the Sidekiq github repo.

  • Copy this file to your server and place it in /lib/systemd/system There are two lines here that require adjustment to your settings;

    1. The working directory path, change this to you application path, for example:
      WorkingDirectory=/home/deploy/my_app/current
    2. The ExecStart path. This specifies the path and command to start Sidekiq. Now this could be different depending on your settings and ruby version managers (if you use one). For example:
      ExecStart=/home/deploy/.rbenv/shims/bundle exec sidekiq -e production
  • After setting up configuration, enable the Sidekiq service with:
    sudo systemctl enable

  • Other commands:

    systemctl stop sidekiq  
    systemctl start sidekiq
    systemctl restart sidekiq
    systemctl kill -s TSTP sidekiq # quiet
    

Change swap size in Ubuntu 18.04

To generate OGImages, recommended to increase size of the swap file
In the following example, we’ll extend the swap space available in the /swapfile to 8 GB

  • Turn off all swap processes
    • sudo swapoff -a
  • Resize the swap
    • sudo dd if=/dev/zero of=/swapfile bs=1G count=8
      if = input file
      of = output file
      bs = block size
      count = multiplier of blocks
  • Make the file usable as swap
    • sudo mkswap /swapfile
  • Activate the swap file
    • sudo swapon /swapfile
  • Check the amount of swap available
    • grep SwapTotal /proc/meminf

QKspace's Projects

qkspace icon qkspace

A minimalistic knowledge base (KB) for small teams

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.