# karika

> YA business automatisation system

Latest version **1.0.1** (published 2016-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install karika
pnpm add karika
yarn add karika
bun add karika
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-11-03 |
| First published | 2016-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 37 |
| Known vulnerabilities | 0 (+10 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Matiushenkov Nikolay, Matiushenkov Igor |
| Maintainers | mnv |
| Keywords | karika, crm, business, bpm |

## Links

- npm: https://www.npmjs.com/package/karika
- Repository: https://github.com/Qeti/Karika
- Issues: https://github.com/Qeti/Karika/issues
- npm.io page: https://npm.io/package/karika

## Dependencies (37)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [less](https://npm.io/package/less.md) ^2.7.1
- [path](https://npm.io/package/path.md) ^0.12.7
- [react](https://npm.io/package/react.md) ^15.3.2
- [jquery](https://npm.io/package/jquery.md) ^3.1.1
- [lodash](https://npm.io/package/lodash.md) ^4.16.6
- [rimraf](https://npm.io/package/rimraf.md) ^2.5.4
- [history](https://npm.io/package/history.md) ^3.2.0
- [webpack](https://npm.io/package/webpack.md) ^1.13.3
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6
- [bootstrap](https://npm.io/package/bootstrap.md) ^3.3.7
- [react-dom](https://npm.io/package/react-dom.md) ^15.3.2
- [babel-core](https://npm.io/package/babel-core.md) ^6.18.0
- [css-loader](https://npm.io/package/css-loader.md) ^0.25.0
- [jsx-loader](https://npm.io/package/jsx-loader.md) ^0.13.2
- [url-loader](https://npm.io/package/url-loader.md) ^0.5.7
- [file-loader](https://npm.io/package/file-loader.md) ^0.9.0
- [json-loader](https://npm.io/package/json-loader.md) ^0.5.4
- [less-loader](https://npm.io/package/less-loader.md) ^2.2.3
- [material-ui](https://npm.io/package/material-ui.md) ^0.16.1
- [babel-loader](https://npm.io/package/babel-loader.md) ^6.2.7
- [browser-sync](https://npm.io/package/browser-sync.md) ^2.17.5
- [cls-bluebird](https://npm.io/package/cls-bluebird.md) ^2.0.1
- [react-router](https://npm.io/package/react-router.md) ^3.0.0
- [strip-loader](https://npm.io/package/strip-loader.md) ^0.1.2
- [style-loader](https://npm.io/package/style-loader.md) ^0.13.1
- [expose-loader](https://npm.io/package/expose-loader.md) ^0.7.1
- [exports-loader](https://npm.io/package/exports-loader.md) ^0.6.3
- [imports-loader](https://npm.io/package/imports-loader.md) ^0.6.5
- [request-promise](https://npm.io/package/request-promise.md) ^4.1.1
- [babel-preset-react](https://npm.io/package/babel-preset-react.md) ^6.16.0
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^1.16.2
- [babel-preset-es2015](https://npm.io/package/babel-preset-es2015.md) ^6.18.0
- [react-tap-event-plugin](https://npm.io/package/react-tap-event-plugin.md) ^1.0.0
- [continuation-local-storage](https://npm.io/package/continuation-local-storage.md) ^3.2.0
- [browser-sync-webpack-plugin](https://npm.io/package/browser-sync-webpack-plugin.md) ^1.1.3
- [extract-text-webpack-plugin](https://npm.io/package/extract-text-webpack-plugin.md) ^1.0.1

## Recent versions

- 1.0.1 (latest) — 2016-11-03
- 1.0.0 — 2016-11-03

## README

Karika
======

## How to install

1. Clone this repository `git clone git@github.com:Qeti/Karika.git`
1. Setup permissions with [following way](http://symfony.com/doc/current/setup/file_permissions.html#using-acl-on-a-system-that-supports-setfacl-linux-bsd):

    ~~~
    $ HTTPDUSER=`ps axo user,comm | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\  -f1`
    # if this doesn't work, try adding `-n` option
    $ sudo setfacl -R -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX var
    $ sudo setfacl -dR -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX var
    ~~~
1. Install dependencies and setup local environment: `composer install`
1. Create database manually with PostgreSQL or with command: `php bin/console doctrine:database:create`
1. Create database schema with command: `php bin/console doctrine:migrations:migrate`
1. Setup web server (root directory is `web`)
1. Open url <karika_url>/api/doc to view methods description.
1. Optionally for development environment. Fill database with fixtures: `php bin/console doctrine:fixtures:load`
1. For development: install node modules with `npm install`
1. For development: run `npm start`

## Api documentation

![API doc](doc/apidoc.png "API documentation")

## Get method of REST API

![REST](doc/get.png "Get method of REST API")

## Access control for POST

![OAuth](doc/auth.png "OAuth")

---
_Source: https://npm.io/package/karika · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
