Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
mauricewijnia committed Sep 30, 2019
2 parents 20e7449 + 818fe49 commit 04cd3eb
Show file tree
Hide file tree
Showing 9 changed files with 2,081 additions and 695 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/vendor
/node_modules
/.vscode
/.vscode
/.idea
67 changes: 67 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# How to contribute to Laraberg

## Reporting issues

When you have an issue with Laraberg there are a few steps you can take to increase the probability that it will get
picked up as
soon as possible:

1. Do you think you can fix the issue yourself? Give it a shot! Check out [how to set up a development environment below](#setting-up-a-development-environment). We're open to any pull requests from small bugfixes to new features. If you're not sure that your pull request will be accepted you can contact us through a Github issue or through
[Gitter](https://gitter.im/VanOns/laraberg) to discuss.
2. Create a Github issue. Make sure to use the issue templates that are available. Following those templates makes it
easier to pinpoint the issue and prevents miscommunication. If your issue does not fit into any of the issue templates
try to be very specific when describing your issue. Reported issue's that consist of only one line of text are very
hard to
work with.

## Setting up a development environment

Setting up a development environment for Laraberg is not as straightforward as it could be.
Laraberg is dependent on the Gutenberg packages from WordPress, and since those are currently not available as an
easy to install NPM package we have to jump through some hoops to make those packages available to Laraberg.

To install Gutenberg:
1. Clone the Gutenberg repository in any directory.
`git clone git@github.com:WordPress/gutenberg.git`
2. CD into the directory
`cd gutenberg`
3. Checkout the latest (working) release (you can check the Laraberg release notes to see what Gutenberg verison is
being used).
`git checkout vX.X.X`
4. Install it's dependencies
`npm install`
5. Build it!
`npm run build`
6. Link it!
`(sudo) npm link`

Now Gutenberg is symlinked to your global node_modules folder and we can use it for the development of Laraberg.
1. Clone Laraberg
`git clone git@github.com:VanOns/laraberg.git`
2. Install dependencies
`composer install`
`yarn install`
3. Link Gutenberg packages
`npm link gutenberg`
4. Start development mode
`npm start`

Now you'll have a local installation of Laraberg that you can use in any Laravel project by adding it to the
`composer.json`:

```json
{
...
"repositories": [
{
"type": "path",
"url": "{path_to_laraberg_directory}"
}
],
"require": {
"van-ons/laraberg": "dev-{branch_name}"
},
...
}

```
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Laraberg aims to provide an easy way to integrate the Gutenberg editor with your
- [Laravel File Manager](#laravel-file-manager)
- [Search Callback](#search-callback)
- [Missing Blocks](#missing-blocks)
- [Contributors](#contributors)
- [Contributing](#contributing)

# Installation

Expand Down Expand Up @@ -404,17 +404,14 @@ This means that the following blocks will only be enabled when you're using Lara
- Gallery
- Media & Text

# Contributors

[![Maurice Wijnia](https://github.com/mauricewijnia.png?size=100)](https://github.com/mauricewijnia) | [![Mike Bronner](https://github.com/mikebronner.png?size=100)](https://github.com/mikebronner)
--- | ---
[Maurice Wijnia](http://mauricewijnia.nl) | [Mike Bronner](https://genealabs.com)
# Contributing

If you want to contribute to Laraberg checkout the [CONTRIBUTING.md](https://github.com/VanOns/laraberg/blob/master/CONTRIBUTING.md)

<div align="center">
<br><br><br>
<a href="https://van-ons.nl">
<img src="https://koenect.van-ons.nl/bestanden/VO-logo_final.svg" width="200" alt="Van Ons">
<svg width="200" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 192 134"><g fill="none"><path fill="#03C758" d="M43.19 90.17H26.13A26.13 26.13 0 0 1 0 64V25.31C0 11.332 11.332 0 25.31 0h97.29c14.431 0 26.13 11.699 26.13 26.13v17.06h17.06c14.431 0 26.13 11.699 26.13 26.13v58.38a5.67 5.67 0 0 1-5.67 5.67H69.32c-14.431 0-26.13-11.699-26.13-26.13z"></path><path fill="#fff" d="M84.54 75.062c4.753 0 8.695 1.519 11.826 4.557 3.132 3.038 4.697 6.861 4.697 11.47s-1.565 8.432-4.697 11.47c-3.13 3.038-7.073 4.557-11.826 4.557-4.733 0-8.664-1.519-11.796-4.557-3.13-3.038-4.696-6.861-4.696-11.47s1.565-8.432 4.696-11.47c3.132-3.038 7.063-4.557 11.796-4.557zm0 9.052c-1.901 0-3.472.651-4.712 1.953s-1.86 2.976-1.86 5.022.62 3.72 1.86 5.022 2.81 1.953 4.712 1.953c1.922 0 3.503-.651 4.743-1.953s1.86-2.976 1.86-5.022-.62-3.72-1.86-5.022-2.821-1.953-4.743-1.953zm40.083-9.052c3.12 0 5.699 1.023 7.734 3.069 2.036 2.046 3.054 4.784 3.054 8.215v19.964h-9.703V89.787c0-1.798-.424-3.183-1.271-4.154s-2.025-1.457-3.534-1.457c-1.426 0-2.604.49-3.534 1.472s-1.395 2.413-1.395 4.294v16.368h-9.703V75.899h9.3v3.813c1.86-3.1 4.877-4.65 9.052-4.65zm42.966 2.635l-2.697 7.564c-3.637-1.55-6.975-2.335-10.013-2.356-2.356 0-3.534.62-3.534 1.86 0 .31.098.573.294.79.197.218.558.409 1.085.574.528.165 1.013.29 1.458.372.444.083 1.131.196 2.061.341l2.232.341c3.265.496 5.74 1.524 7.424 3.084 1.685 1.56 2.527 3.612 2.527 6.154 0 3.348-1.24 5.962-3.72 7.843-2.48 1.88-5.931 2.821-10.354 2.821-6.097 0-10.778-1.064-14.043-3.193l3.379-7.502c3.203 1.901 6.779 2.852 10.726 2.852 2.831 0 4.247-.661 4.247-1.984 0-.579-.351-1.018-1.054-1.317-.703-.3-1.953-.584-3.751-.853l-1.767-.248c-3.658-.537-6.36-1.586-8.107-3.147-1.746-1.56-2.619-3.704-2.619-6.432 0-3.224 1.152-5.725 3.457-7.502 2.304-1.777 5.533-2.666 9.687-2.666 2.439 0 4.593.191 6.463.573 1.87.383 4.077 1.06 6.619 2.031zM56.425 29.899L44.8 60.31H33.733l-11.78-30.411h10.571l6.789 19.84 6.851-19.84zm33.092 0V60.31h-9.393v-3.286c-2.087 2.728-5.001 4.092-8.742 4.092-4.03 0-7.393-1.545-10.09-4.635-2.698-3.09-4.046-6.897-4.046-11.423 0-2.955.61-5.652 1.829-8.091 1.22-2.439 2.914-4.366 5.084-5.781 2.17-1.416 4.588-2.124 7.254-2.124 3.7 0 6.603 1.374 8.711 4.123v-3.286zm-15.81 8.215c-1.922 0-3.482.661-4.681 1.984s-1.798 2.986-1.798 4.991.6 3.668 1.798 4.991c1.199 1.323 2.759 1.984 4.681 1.984 1.901 0 3.462-.656 4.681-1.968 1.22-1.313 1.829-2.982 1.829-5.007s-.61-3.694-1.829-5.006c-1.22-1.313-2.78-1.969-4.681-1.969zm40.966-9.052c3.12 0 5.699 1.023 7.735 3.069 2.035 2.046 3.053 4.784 3.053 8.215V60.31h-9.703V43.787c0-1.798-.424-3.183-1.271-4.154s-2.025-1.457-3.534-1.457c-1.426 0-2.604.49-3.534 1.472s-1.395 2.413-1.395 4.294V60.31h-9.703V29.899h9.3v3.813c1.86-3.1 4.877-4.65 9.052-4.65z"></path></g></svg>
</a>
<br>
</div>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "laraberg",
"version": "1.0.1",
"version": "1.0.2",
"description": "A Gutenberg implementation for Laravel",
"main": "src/resources/laraberg.js",
"directories": {
Expand Down
Loading

0 comments on commit 04cd3eb

Please sign in to comment.