Skip to content

Commit ed0996a

Browse files
cornernotecornernote
committed
added base documentation
1 parent e48ffdb commit ed0996a

7 files changed

+205
-0
lines changed

‎.scrutinizer.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
checks:
4+
php:
5+
code_rating: true
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true
19+
tools:
20+
external_code_coverage:
21+
timeout: 600
22+
runs: 3
23+
php_analyzer: true
24+
php_code_coverage: false
25+
php_code_sniffer:
26+
config:
27+
standard: PSR2
28+
filter:
29+
paths: ['src']
30+
php_loc:
31+
enabled: true
32+
excluded_dirs: [vendor, tests]
33+
php_cpd:
34+
enabled: true
35+
excluded_dirs: [vendor, tests]

‎.travis.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
language: php
2+
3+
php:
4+
- hhvm
5+
- 5.6
6+
- 5.5
7+
- 5.4
8+
9+
env:
10+
- DB=mysql
11+
# - DB=pgsql
12+
13+
install:
14+
- travis_retry composer self-update
15+
- travis_retry composer global require "fxp/composer-asset-plugin:1.0.*"
16+
- travis_retry composer global require "codeception/codeception:2.0.*"
17+
- travis_retry composer install --no-interaction --prefer-dist
18+
- ln -s `pwd`/vendor/bower-asset `pwd`/vendor/bower
19+
20+
before_script:
21+
- if [[ $TRAVIS_PHP_VERSION =~ ^hhvm ]]; then echo 'xdebug.enable = On' >> /etc/hhvm/php.ini; fi
22+
- if [[ "$DB" == "mysql" ]]; then mysql -e "create database IF NOT EXISTS dashboard_test;" -uroot; fi
23+
# - if [[ "$DB" == "pgsql" ]]; then psql -c "DROP DATABASE IF EXISTS dashboard_test;" -U postgres; fi
24+
# - if [[ "$DB" == "pgsql" ]]; then psql -c "create database dashboard_test;" -U postgres; fi
25+
- cd tests
26+
- php codeception/_app/yii migrate/up --interactive=0
27+
- php codeception/_app/yii migrate/up --migrationPath=../src/migrations --interactive=0
28+
- ~/.composer/vendor/bin/codecept build
29+
30+
script:
31+
- ~/.composer/vendor/bin/codecept run --coverage-html --coverage-xml
32+
33+
after_script:
34+
- php ../vendor/bin/ocular code-coverage:upload --format=php-clover codeception/_output/coverage.xml
35+
36+
after_failure:
37+
- cat codeception/_app/runtime/logs/*
38+
- cat codeception/_output/*
39+
40+
notifications:
41+
webhooks:
42+
urls:
43+
- https://webhooks.gitter.im/e/b8a97760936530897759
44+
on_success: change
45+
on_failure: always
46+
on_start: false

‎CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 0.1.0
4+
5+
* initial relase

‎CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/cornernote/yii2-dashboard).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
23+
24+
25+
## Running Tests
26+
27+
``` bash
28+
$ cd tests
29+
$ codecept run
30+
```
31+
32+
33+
**Happy coding**!

‎CREDITS.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Credits
2+
3+
## Developers
4+
5+
* [Brett O'Donnell (cornernote)](https://github.com/cornernote)
6+
7+
## Related Projects
8+
9+
* [Krajee Yii2 Sortable](https://github.com/kartik-v/yii2-sortable)

‎LICENSE.md

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

‎README.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Yii2 Dashboard
2+
3+
[![Latest Version](https://img.shields.io/github/tag/cornernote/yii2-dashboard.svg?style=flat-square&label=release)](https://github.com/cornernote/yii2-dashboard/tags)
4+
[![Software License](https://img.shields.io/badge/license-BSD-brightgreen.svg?style=flat-square)](LICENSE.md)
5+
[![Build Status](https://img.shields.io/travis/cornernote/yii2-dashboard/master.svg?style=flat-square)](https://travis-ci.org/cornernote/yii2-dashboard)
6+
[![HHVM](https://img.shields.io/hhvm/cornernote/yii2-dashboard.svg?style=flat-square)](http://hhvm.h4cc.de/package/cornernote/yii2-dashboard)
7+
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/cornernote/yii2-dashboard.svg?style=flat-square)](https://scrutinizer-ci.com/g/cornernote/yii2-dashboard/code-structure)
8+
[![Quality Score](https://img.shields.io/scrutinizer/g/cornernote/yii2-dashboard.svg?style=flat-square)](https://scrutinizer-ci.com/g/cornernote/yii2-dashboard)
9+
[![Total Downloads](https://img.shields.io/packagist/dt/cornernote/yii2-dashboard.svg?style=flat-square)](https://packagist.org/packages/cornernote/yii2-dashboard)
10+
[![Yii2 Framework](https://img.shields.io/badge/extension-Yii2_Framework-green.svg?style=flat-square)](http://www.yiiframework.com/extension/yii2-dashboard)
11+
12+
Yii2 Dashboard is a module that allows you to create and manage dashboards using custom layouts and panels.
13+
14+
## Features
15+
16+
* todo
17+
18+
19+
## Documentation
20+
21+
Getting started? Try the [Installation Guide](docs/installation.md). You will find further information in the [Documentation](docs/README.md).
22+
23+
For changes since the last version see the [Changelog](CHANGELOG.md).
24+
25+
26+
## Screenshots
27+
28+
### todo
29+
30+
31+
## Contributing
32+
33+
Contributions are welcome. Please refer to the [contributing guidelines](CONTRIBUTING.md).
34+
35+
Thanks to [everyone who has contributed](CREDITS.md).
36+
37+
38+
## Project Resources
39+
40+
* [GitHub Project](https://github.com/cornernote/yii2-dashboard)
41+
* [Yii2 Extension](http://www.yiiframework.com/extension/yii2-dashboard)
42+
* [Packagist Package](https://packagist.org/packages/cornernote/yii2-dashboard)
43+
* [Travis CI Testing](https://travis-ci.org/cornernote/yii2-dashboard)
44+
* [Scrutinizer CI Code Quality](https://scrutinizer-ci.com/g/cornernote/yii2-dashboard)
45+
46+
47+
## License
48+
49+
BSD-3 - Please refer to the [license](LICENSE.md).

0 commit comments

Comments
 (0)