Skip to content
This repository has been archived by the owner on Nov 15, 2020. It is now read-only.

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Hyleeh committed Jul 30, 2016
0 parents commit 6fba1ce
Show file tree
Hide file tree
Showing 19 changed files with 1,013 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
language: php

php:
- 5.5
- 5.6

env:
- LARAVEL_VERSION="5.2.*" TESTBENCH_VERSION="3.2.*"

before_script:
- composer self-update
- composer require orchestra/testbench:${TESTBENCH_VERSION} illuminate/support:"$LARAVEL_VERSION"
- composer install

script: phpunit
26 changes: 26 additions & 0 deletions Gulpfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
var gulp = require('gulp');
var phpunit = require('gulp-phpunit');
var run = require('gulp-run');
var notify = require('gulp-notify');

gulp.task('test', function() {
gulp.src('phpunit.xml')
.pipe(run('clear'))
.pipe(phpunit('', { notify: true }))
.on('error', notify.onError({
title: 'Red!',
message: 'Your tests failed...'
}))
.pipe(notify(
{
title: 'Green!',
message: 'Your tests succeeded!'
}
));
});

gulp.task('watch', function() {
gulp.watch(['tests/**/*.php'], ['test']);
});

gulp.task('default', ['test', 'watch']);
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 kenarkose

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Synthesizer
The markdown and text processor that Nuclear CMS needs.

---
[![Build Status](https://travis-ci.org/NuclearCMS/Synthesizer.svg?branch=master)](https://travis-ci.org/NuclearCMS/Synthesizer)
[![Total Downloads](https://poser.pugx.org/Nuclear/Synthesizer/downloads)](https://packagist.org/packages/Nuclear/Synthesizer)
[![Latest Stable Version](https://poser.pugx.org/Nuclear/Synthesizer/version)](https://packagist.org/packages/Nuclear/Synthesizer)
[![License](https://poser.pugx.org/Nuclear/Synthesizer/license)](https://packagist.org/packages/Nuclear/Synthesizer)

This package is intended for [Nuclear CMS](https://github.com/NuclearCMS/Nuclear) and it constitutes its main markdown and text processing functionality. It is developed separately to enable individual development, testing and possible reuse.

## Installation
Installing Synthesizer is simple.

1. Pull this package in through [Composer](https://getcomposer.org).
```js
{
"require": {
"nuclear/synthesizer": "~0.9"
}
}
```

2. In order to register Synthesizer Service Provider add `'Nuclear\Synthesizer\SynthesizerServiceProvider'` to the end of `providers` array in your `config/app.php` file.
```php
'providers' => array(
'Illuminate\Foundation\Providers\ArtisanServiceProvider',
'Illuminate\Auth\AuthServiceProvider',
...
'Nuclear\Synthesizer\SynthesizerServiceProvider',
),
```

3. Publish the migrations and configuration files.
```bash
php artisan vendor:publish --provider:"Nuclear\Synthesizer\SynthesizerServiceProvider"
```
Do not forget to migrate the database.

4. Please check the tests and source code for further documentation.

## License
Synthesizer is released under [MIT License](https://github.com/NuclearCMS/Synthesizer/blob/master/LICENSE).
45 changes: 45 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "nuclear/synthesizer",
"description": "The markdown and text processor that Nuclear CMS needs.",
"license": "MIT",
"keywords": [
"kenarkose",
"nuclear",
"nuclearcms",
"synthesizer",
"markdown",
"laravel",
"laravel5"
],
"version": "0.9.0",
"authors": [
{
"name": "Hyleeh",
"email": "egemen@kenarkose.com",
"homepage": "http://egemenkizilcan.com",
"role": "Developer / Designer"
}
],
"require": {
"php": ">=5.5.9",
"erusev/parsedown-extra": "~0.7"
},
"require-dev": {
"orchestra/testbench": "~3.2",
"phpunit/phpunit": "~4.0",
"nuclear/documents": "~0.9"
},
"autoload": {
"psr-4": {
"Nuclear\\Synthesizer\\": "src/"
}
},
"autoload-dev": {
"classmap": [
"tests"
]
},
"suggest": {
"laravel/framework": "This package requires Laravel 5."
}
}
8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"devDependencies": {
"gulp": "^3.8.11",
"gulp-notify": "^2.2.0",
"gulp-phpunit": "^0.8.1",
"gulp-run": "^1.6.6"
}
}
18 changes: 18 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false">
<testsuites>
<testsuite name="Package Test Suite">
<directory suffix=".php">./tests/</directory>
<exclude>./tests/TestBase.php</exclude>
</testsuite>
</testsuites>
</phpunit>
Loading

0 comments on commit 6fba1ce

Please sign in to comment.