Skip to content

Commit

Permalink
Add CHANGELOG.md, LICENSE.md, README.md, description, screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Gustl22 committed Jul 24, 2020
1 parent 7a15021 commit 2e5458f
Show file tree
Hide file tree
Showing 10 changed files with 772 additions and 88 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Changelog

## [Unreleased]

## [0.1.0] - 2020-07-27
- create Gutenberg plugin
- Enable client side scripts
- React components (FullCalendar v5.1, Material-UI v4.10)
- port admin panel from WP-FullCalendar
- port & adapt short-codes from WP-FullCalendar
- custom calendar views
- adapt theme system

[unreleased]: https://github.com/Oberhauser-Dev/gb-fullcalendar/compare/0.1.0...HEAD
[0.1.0]: https://github.com/Oberhauser-Dev/gb-fullcalendar/releases/tag/0.1.0
675 changes: 675 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
## GB FullCalendar
- Contributors: August Oberhauser
- Tags: block, fullcalendar, react
- Requires at least: 5.3.2
- Tested up to: 5.4.2
- Stable tag: 0.1.0
- Requires PHP: 7.0.0
- License: GPL-3.0-or-later
- License URI: https://www.gnu.org/licenses/gpl-3.0.html

GB FullCalendar is a branch of the popular WP FullCalendar plugin written as a Gutenberg block.

## Description

Thanks to the Gutenberg-Blocks since the end of 2018, it has become incredibly easy to add and layout your blocks in a
visual way, but still can be used with Short-Codes, too.

### Features

- Month/Week/Day/List views
- Filter by taxonomy, such as category, tag etc.
- Integrates seamlessly with [Events Manager](http://wordpress.org/extend/plugins/events-manager/)

### Credits

Thanks to [Marcus Sykes](https://profiles.wordpress.org/netweblogic/) for his previous work on WP Fullcalendar, which was partially in here.

## Installation

1. Upload the plugin files to the `/wp-content/plugins/gb-fullcalendar` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress


## Frequently Asked Questions (FAQ)

None yet.

## Screenshots

![Desktop](./assets/GB-FullCalendar-desktop.png)
![Mobile & Theme](./assets/GB-FullCalendar-theme-mobil.png)

## Changelog

See [changelog file](./CHANGELOG.md).

## Contribution

You are invited to help in form of Merge-Requests or proposing issues with the expected solutions.

To develop install the packages via `npm i`. Then start webpack compiling via `npm start`.
To build a plugin file run `npm run build` and include the following files in a folder named `gb-fullcalendar` and compress it to a zip file.

```
build/
editor.css
gb-fc-admin.php
gb-fullcalendar.php
package.json
style.css
```

**The plugin is freely to use. We are not liable for any damage caused by using the plugin!**
Binary file added assets/GB-FullCalendar-desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/GB-FullCalendar-theme-mobil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions gb-fc-admin.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ public static function admin_options()
<div class="handlediv" title="Click to toggle"></div>
<h3 class="hndle" style="color:green;">GB FullCalendar (Alpha)</h3>
<div class="inside">
<p>This plugin is a fresh branch of the popular plugin WP-FullCalendar.
Thanks to the Gutenberg Blocks since the end of 2018 it has become incredibly easy
to add and layout your blocks in a visual way, but also can still be used with
Short-Codes.<br/><br/>
<p>This plugin is a branch of the popular WP-FullCalendar plugin.
Thanks to the Gutenberg-Blocks since the end of 2018, it has become incredibly easy
to add and layout your blocks in a visual way, but still can be used with
Short-Codes, too.<br/><br/>
The Guten-Berg (GB) FullCalendar is based on the flexible and component based framework
React.
It is developed by <a href="http://oberhauser.dev/">August Oberhauser</a>.
Expand Down
2 changes: 1 addition & 1 deletion gb-fullcalendar.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* Plugin Name: GB FullCalendar
* Plugin URI: https://github.com/oberhauser-dev/gb-fullcalendar/
* Description: gb-fullcalendar — is an updated alternative to the wp-fullcalendar as a Gutenberg plugin.
* Description: GB FullCalendar is a branch of the popular WP FullCalendar plugin written as a Gutenberg block.
* Version: 0.1.0
* Author: August Oberhauser
* Author URI: https://www.oberhauser.dev/
Expand Down
12 changes: 10 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
"name": "gb-fullcalendar",
"version": "0.1.0",
"description": "Example block written with ESNext standard and JSX support – build step required.",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"author": "August Oberhauser",
"license": "GPL-3.0-or-later",
"contributors": [
{
"name": "August Oberhauser",
"email": "git@reb0.org",
"url": "https://www.reb0.org/"
}
],
"repository": "https://github.com/Oberhauser-Dev/gb-fullcalendar.git",
"main": "build/index.js",
"scripts": {
"build": "wp-scripts build",
Expand Down
57 changes: 0 additions & 57 deletions readme.txt

This file was deleted.

28 changes: 4 additions & 24 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ registerBlockType( 'create-block/gb-fullcalendar', {
* It will be shown in the Block Tab in the Settings Sidebar.
*/
description: __(
'Example block written with ESNext standard and JSX support – build step required.',
'GB FullCalendar is a branch of the popular WP FullCalendar plugin written as a Gutenberg block.',
'create-block'
),

Expand All @@ -53,7 +53,9 @@ registerBlockType( 'create-block/gb-fullcalendar', {

keywords: [
__( 'fullcalendar' ),
__( 'guten-block' ),
__( 'calendar' ),
__( 'gutenberg-block' ),
__( 'react' ),
],

/**
Expand All @@ -72,28 +74,6 @@ registerBlockType( 'create-block/gb-fullcalendar', {
initialView: {
type: 'string',
},
// content: {
// type: 'string',
// source: 'html',
// selector: 'p',
// },
// checkboxField: {
// type: 'boolean',
// default: true,
// },
// radioField: {
// type: 'string',
// default: 'yes',
// },
// textField: {
// type: 'string',
// },
// toggleField: {
// type: 'boolean',
// },
// selectField: {
// type: 'string',
// },
},

/**
Expand Down

0 comments on commit 2e5458f

Please sign in to comment.