Coder Social home page Coder Social logo

Build Status latest release License AGPL-3.0

K-Box

The digital tool for projects in the field: Web-based application to manage documents, images, videos and geodata. It contains a full content search, a translated interface into several languages and it connects easily to the K-Link services.

Visit the K-Link technology website for more information!

If you find any issues with this application, please report them at the issue tracker. Contributions are both encouraged and appreciated. If you would like to contribute, please check the website for more information.

The upstream repository is at: https://github.com/k-box/k-box

Installation

K-Box can be installed on most operating systems. The setup is heavily based on Docker.

Prerequisites

Simplest installation

These few commands allow you to quickly install a K-Box locally on your computer for testing purposes.

  • Create a directory: mkdir k-box && cd k-box
  • Download configuration file: curl -o docker-compose.yml https://raw.githubusercontent.com/k-box/k-box/master/docker-compose.example.yml
  • Start up services: docker-compose up -d or sudo docker-compose up -d, depending on your configuration of Docker (when running this for the first time, it will download a lot of data and take a while)
  • Create the administrator: docker-compose exec kbox php artisan create-admin [email protected] or sudo docker-compose exec kbox php artisan create-admin [email protected], depending on your configuration of Docker
  • Visit your K-Box: http://localhost:8080 (you can login to the K-Box with the username [email protected] and the chosen password).

For installation on a server in the Internet or more configuration options, see the documentation on installation of the K-Box.

Components

The K-Box consists of different components:

Name Image Based on Description
K-Box application kbox PHP and Laravel The interface of the knowledge management system
K-Search API ksearch PHP and Symfony 4 Full text search component used for K-Link and K-Box
K-Search Engine engine Apache SOLR Open Source search engine pre-configured for the K-Search
Database database MariaDB A database for the use of the K-Box web application.

Development

Programmers may check out the developers documentation

Testing

The K-Box code is covered by unit tests. For more information see Executing Unit Tests.

Contributing

Your contribution is very welcome. Find more information in our contribution guide.

License

The K-Box is licensed under the GNU Affero General Public License v3.0.

This program is Free Software: You can use, study, share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the AGPL 3.0 license.

K-* Technologies's Projects

http-failure-server icon http-failure-server

A quick implementation of a mock server, to test the asynchronous file download of the K-Search

k-box icon k-box

Web-based application to manage documents, images, videos and geodata.

k-box-reporter icon k-box-reporter

Template website and tool to show and retrieve K-Box usage data

k-link icon k-link

Connects various information sources to a common digital library and provides search, retrieval and exchange of information from different platforms.

k-link-registry icon k-link-registry

Orchestrator of applications connected to a K-Link and their permissions.

k-search icon k-search

A common api for full text based retrieval. Used for the K-Link and the K-Box.

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.