https://github.com/oneplc/plc_x_book

Book Module for onePlace X
https://github.com/oneplc/plc_x_book

Last synced: about 1 month ago
JSON representation

Book Module for onePlace X

• Host: GitHub
• URL: https://github.com/oneplc/plc_x_book
• Owner: OnePlc
• License: bsd-3-clause
• Created: 2020-01-28T15:11:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-01-29T12:14:24.000Z (over 5 years ago)
• Last Synced: 2025-01-31T08:35:18.909Z (3 months ago)
• Language: PHP
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# oneplace-book

[![Build Status](https://travis-ci.com/OnePlc/PLC_X_Book.svg?branch=master)](https://travis-ci.com/OnePlc/PLC_X_Book)

[![Coverage Status](https://coveralls.io/repos/github/OnePlc/PLC_X_Book/badge.svg?branch=master)](https://coveralls.io/github/OnePlc/PLC_X_Book?branch=master)

## Introduction

This is the Book Module for onePlace Software Framework based on Laminas Project (former Zend Framework)

This modul is based on [oneplace-skeleton](https://github.com/OnePlc/PLC_X_Skeleton) with a few modification to extend its functionality.

In the /data folder you will find usefull custom sql scripts for adding all sorts of additional fields for this specific Book module.

## Book Module

This book module is a starting point for your own onePlace modules.

It expands on [oneplace-core](https://github.com/OnePlc/PLC_X_Core) and uses the onePlace / Laminas MVC layer and module systems.

## Installation

The easiest way to install onePlace Book is via composer

```shell script

composer require oneplace/oneplace-book

```

After installation you can apply a custom sql config.

 

You simply copy the SQL Code from [structure_example_simnple.sql](https://github.com/OnePlc/PLC_X_Book/tree/master/data/structure_example_simnple.sql]) and [data_example_simnple.sql](https://github.com/OnePlc/PLC_X_Book/tree/master/data/data_example_simnple.sql]) and run ist on your database.

We also prepared a extended version of a custom SQL config for a better demonstaration of its capability.

## Getting started

how to utilize user manager

how to create own modules

## Documentation

Documentation will be extended soon.