Skip to content

Commit e34b48a

Browse files
author
Praesidiarius
committed
first stable
1 parent 852b8bb commit e34b48a

File tree

12 files changed

+244
-0
lines changed

12 files changed

+244
-0
lines changed

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.vagrant/
2+
.idea/
3+
vendor/
4+
config/development.config.php
5+
public/themes/vuze
6+
public/themes/ablepro
7+
data/cache/*
8+
!data/cache/.gitkeep
9+
phpunit.xml
10+
composer.lock
11+
.phpunit.result.cache
12+
docs/html/

.travis.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
language: php
2+
3+
cache:
4+
directories:
5+
- $HOME/.composer/cache
6+
7+
env:
8+
global:
9+
- COMPOSER_ARGS="--no-interaction"
10+
- COVERAGE_DEPS="php-coveralls/php-coveralls"
11+
12+
matrix:
13+
fast_finish: true
14+
include:
15+
- php: 7.2
16+
env:
17+
- DEPS=lowest
18+
- php: 7.2
19+
env:
20+
- DEPS=latest
21+
- CS_CHECK=true
22+
23+
before_install:
24+
- if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
25+
26+
install:
27+
- travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs
28+
- if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi
29+
- if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
30+
- if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
31+
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
32+
- stty cols 120 && composer show
33+
34+
script:
35+
- if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
36+
- if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi
37+
38+
after_script:
39+
- if [[ $TEST_COVERAGE == 'true' ]]; then vendor/bin/php-coveralls -v ; fi
40+
41+
notifications:
42+
email: false

COPYRIGHT.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Copyright (c) 2019-2020, Verein onePlace
2+
All rights reserved. (https://1plc.ch/)

LICENSE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2019-2020, Verein onePlace
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
7+
- Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
- Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
14+
- Neither the name of Verein onePlace nor the names of its contributors may
15+
be used to endorse or promote products derived from this software without
16+
specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# oneplace-account
2+
3+
[![Build Status](https://travis-ci.com/OnePlc/PLC_X_Account.svg?branch=master)](https://travis-ci.com/OnePlc/PLC_X_Account)
4+
[![Coverage Status](https://coveralls.io/repos/github/OnePlc/PLC_X_Account/badge.svg?branch=master)](https://coveralls.io/github/OnePlc/PLC_X_Account?branch=master)
5+
6+
## Introduction
7+
8+
This is the Account Module for onePlace Software Framework based on Laminas Project (former Zend Framework)
9+
10+
Create your web based apps on the fly! onePlace brings you extended Entity and Table Models,
11+
View Helpers and much more - so you can build your Webapp to manage database based data,
12+
in almost any layout you can image.
13+
14+
onePlace is built for maximum freedom of choice for your app, and so only small
15+
parts of laminas mvc are utilized. a lot is done from scratch to give you more freedom / customization.
16+
17+
## Account Module
18+
19+
This account module is a starting point for your own onePlace modules.
20+
It expands on [oneplace-core](https://github.com/OnePlc/PLC_X_Core) and uses the onePlace / Laminas MVC layer and module systems.
21+
22+
## Installation
23+
24+
The easiest way to install onePlace Account is via composer
25+
```shell script
26+
composer require oneplace/oneplace-account
27+
```
28+
29+
## Getting started
30+
31+
how to utilize user manager
32+
33+
how to create own modules
34+
35+
## Documentation
36+
37+
Documentation will be extended soon.

composer.json

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"name": "oneplace/oneplace-account",
3+
"description": "onePlace Account Module",
4+
"type": "oneplace-module",
5+
"license": "BSD-3-Clause",
6+
"keywords": [
7+
"laminas",
8+
"mvc",
9+
"account",
10+
"oneplace",
11+
"oneplace-module",
12+
"framework"
13+
],
14+
"require-dev": {
15+
"phpunit/phpunit": "^8",
16+
"oneplace/oneplace-core": "^1.0.0",
17+
"laminas/laminas-test": "^3.3.0"
18+
},
19+
"require": {
20+
"php": "^7.1",
21+
"oneplace/oneplace-core": "^1.0.6.1",
22+
"phpoffice/phpspreadsheet": "^1.10"
23+
},
24+
"autoload": {
25+
"psr-4": {
26+
"OnePlace\\Account\\": "src/"
27+
}
28+
},
29+
"autoload-dev": {
30+
"psr-4": {
31+
"OnePlaceTest\\Account\\": "test/"
32+
}
33+
},
34+
"scripts": {
35+
"cs-check": "phpcs",
36+
"cs-fix": "phpcbf",
37+
"development-disable": "laminas-development-mode disable",
38+
"development-enable": "laminas-development-mode enable",
39+
"development-status": "laminas-development-mode status",
40+
"post-create-project-cmd": [
41+
"@development-enable",
42+
"php -r '$file = file_get_contents(\".gitignore\"); $file = str_replace(\"composer.lock\", \"\", $file); file_put_contents(\".gitignore\", $file);'"
43+
],
44+
"serve": "php -S 0.0.0.0:8080 -t public",
45+
"test": "phpunit"
46+
},
47+
"extra": {
48+
"zf": {
49+
"module": "OnePlace\\Article"
50+
}
51+
}
52+
}

docs/book/dynamic-fields.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Dynamic Fields
2+
3+
As with every oneplace-skeleton based Module, you have dynamic fields
4+
for onePlace Account. So you can fully customize your experience with
5+
Accounts, by defining own Tabs, Fields and Permissions.
6+
7+
Read more about dynamic fields in the [oneplace-skeleton documentation](https://docs.1plc.ch/oneplace-skeleton/dynamic-fields/)

docs/book/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# oneplace-account
2+
3+
onePlace X Account Module. Used for linking our hosted
4+
and subscription based installations to a central management server.
5+
6+
## Installation
7+
8+
Using composer
9+
10+
```bash
11+
$ composer require oneplace/oneplace-account
12+
```
13+
14+
## Support
15+
16+
* Issues: [github.com/oneplc/plc_x_account/issues](https://github.com/oneplc/plc_x_account/issues)
17+
* Source: [github.com/oneplc/plc_x_account/](https://github.com/oneplc/plc_x_account/)
18+
* Chat: [docs.1plc.ch/chat](https://docs.1plc.ch/chat)
19+
* Forum: [discourse.1plc.ch](https://discourse.1plc.ch)

docs/book/intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Introduction
2+

docs/book/quick-start.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Quick Start
2+
3+
Now that you have basic knowledge of the accizbt Module and how its
4+
structured, we'll show you the easy way to get started.
5+
6+
## Install the onePlace Account
7+
8+
The easiest way to get started is to install the onePlace Account via Composer.
9+
10+
If you have not yet done so, [install Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
11+
12+
```bash
13+
$ composer require oneplace/oneplace-account
14+
```
15+
16+
## Use a pre-defined set of fields and settings
17+
18+
use _*simple or _*extended files in ./data or create your own

mkdocs.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
docs_dir: docs/book
2+
site_dir: docs/html
3+
nav:
4+
- Home: index.md
5+
- Introduction: intro.md
6+
- 'Quick Start': quick-start.md
7+
- 'Dynamic Fields': dynamic-fields.md
8+
site_name: oneplace-skeleton
9+
site_description: "onePlace Application Skeleton Module"
10+
repo_url: 'https://github.com/OnePlc/PLC_X_Skeleton'
11+
theme: bootstrap4
12+
extra:
13+
project: onePlc

phpunit.xml.dist

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit colors="true">
3+
<testsuites>
4+
<testsuite name="Article Module Test Suite">
5+
<directory>./test</directory>
6+
</testsuite>
7+
</testsuites>
8+
<filter>
9+
<whitelist addUncoveredFilesFromWhitelist="true">
10+
<directory suffix=".php">./src</directory>
11+
</whitelist>
12+
</filter>
13+
</phpunit>

0 commit comments

Comments
 (0)