Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md #866

Merged
merged 17 commits into from
Sep 12, 2024
Binary file added docs/media/gatherpress-awesome-playground.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 docs/media/playground-plugins-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
129 changes: 68 additions & 61 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,31 @@ GatherPress, powering our community's event management needs.

GatherPress, a plugin created by and for the WordPress community, is a response to the community's desire for novel event management tools that meet the diverse needs of event organizers and members. Its agenda and roadmap align with that of the WordPress community, ensuring that it evolves in tandem with our collective wants and needs.

**We propose a pilot program to test GatherPress, a community-developed plugin, within interested and active WordPress meetup groups. This initiative stems from our community’s need for an innovative event management tool tailored to the unique demands of WordPress event organizers and participants.**
[@Patricia BT](https://profiles.wordpress.org/patricia70/) in January 2024 on [make.wordpress.org](https://make.wordpress.org/community/2024/01/22/proposal-pilot-program-to-test-gatherpress-on-the-wordpress-org-network-as-a-meetup-alternative/)
## Pilot Program

This project is for the collaborative effort to build a compelling event management application using open source tools such as _WordPress_ and _BuddyPress_ and the grit sweat and love of **the community, for the community**.
**We propose a pilot program to test GatherPress**, a community-developed plugin, within interested and active WordPress meetup groups. This initiative stems from our community’s need for an innovative event management tool tailored to the unique demands of WordPress event organizers and participants. Our proposal in January 2024 on [make.wordpress.org](https://make.wordpress.org/community/2024/01/22/proposal-pilot-program-to-test-gatherpress-on-the-wordpress-org-network-as-a-meetup-alternative/)

We're creating the very network features we need to host events and gather well.
## Community-built

https://www.youtube.com/watch?v=BnYS36C5d38&t=2s
This project is the result of a collaborative effort to build a compelling event management application using open source tools such as _WordPress_ and _BuddyPress_ and with the grit, sweat, and love of **the community, for the community**. We encourage all interested, whether a user, community member, or developer, to follow our emerging presence on our [GatherPress Blog](https://gatherpress.org/blog/), our [GitHub repositories](https://github.com/GatherPress/), our [GatherPress Documentation](https://gatherpress.org/documentation/), or new features on our [GatherPress Playground](https://playground.wordpress.net/builder/builder.html?blueprint-url=https://raw.githubusercontent.com/GatherPress/gatherpress-awesome/main/.wordpress-org/blueprints/blueprint.json).

## Playground Environment

The GatherPress Playground allows you to test the current state of GatherPress with existing data in a fully-functional environment.

![GatherPress Playground screenshot](./docs/media/playground-plugins-link.png)

The playground is built on the WordPress Playground with customizable json data that you can customize as you like. To get started, click the [button above](https://wordpress.org/plugins/gatherpress/?preview=1), or delve deeper by:

- Clicking the “Live Preview” button on WordPress.org GatherPress plugin page
- Instantly previewing changes from a commented Playground-link on each PR
- Automatically generating multilingual screenshots for WordPress.org plugins
- Run end-to-end tests (still a PR)
- Curating and maintaining your own set of demo-data, which is reusable in all WP Playgrounds.

For an introduction as to what we are creating and the specific features needed to host events and gather well, please view the [introductory video](https://www.youtube.com/watch?v=BnYS36C5d38&t=2s).

https://gatherpress.org/demovideo

### Features

Expand All @@ -55,10 +71,6 @@ https://www.youtube.com/watch?v=BnYS36C5d38&t=2s
- Email notification when event starts. ([#](https://github.com/GatherPress/gatherpress/issues/429))
- Event federation using ActivityPub ([#](https://github.com/GatherPress/gatherpress/issues/569))

### Contribute

If you wish to share in the collaborative of work to build GatherPress, please drop us a line either via [WordPress Slack](https://make.wordpress.org/chat/) or on [GatherPress.org](https://gatherpress.org/get-involved). The development location of the GatherPress project can be found at [https://github.com/gatherpress/gatherpress](https://github.com/gatherpress/gatherpress). All contributions are welcome: code, design, user interface, documentation, [translation](https://translate.wordpress.org/projects/wp-plugins/gatherpress/) and more.

### Third-Party Libraries

This plugin leverages the following third-party libraries for various functionalities:
Expand All @@ -67,23 +79,30 @@ This plugin leverages the following third-party libraries for various functional
- [React-Tooltip](https://github.com/wwayne/react-tooltip): Provides customizable tooltips for React applications.
- [Leaflet](https://leafletjs.com/): Provides global, open-source mapping functionality

## Screenshots
## Installation

1. Create a new event
![Create a new event](.wordpress-org/screenshot-1.png)
2. Create a new venue
![Create a new venue](.wordpress-org/screenshot-2.png)
3. General Settings
![General Settings](.wordpress-org/screenshot-3.png)
4. Leadership Settings
![Leadership Settings](.wordpress-org/screenshot-4.png)
### Installation from the WordPress repository

## Installation
GatherPress is now available on the WordPress plugins repository and able to be installed like any other plugin.

1. Download the plugin: you'll find the latest release on the GatherPress GitHub repository, under [Releases](https://github.com/GatherPress/gatherpress/releases) > Assets and download `gatherpress.zip`.
2. Install it in your WordPress instance: go to WP Admin Plugins > Add new plugin. Choose the `gatherpress.zip` file you just downloaded.
1. Navigate to your site's wp-admin area, and in the left-side menu click on Plugins > Add new plugin.
2. Search for `gatherpress` in the search box and click the Install button.
3. Activate the plugin.

<img width="854" alt="plugins-page-search" src="https://github.com/user-attachments/assets/579f5cd4-741e-4870-86e9-838714cb91bb">

### Installation from GitHub

Since this plugin is in active development by the community, features and functionality are still evolving. For the latest updates to GatherPress, consult our [GitHub page](https://github.com/GatherPress/).

1. To find the latest release for installation, use the link under [Releases](https://github.com/GatherPress/gatherpress/releases) > Assets to download `gatherpress.zip`.
2. Then go to your wp-admin plugins page and click on the `Upload Plugin` button.
3. Click on the `Choose File` button at the center of your screen to select the `gatherpress.zip` file you just downloaded.
4. Select the proper zip file, click Open, then `Install Now`.
5. Activate the plugin.

<img width="954" alt="upload-plugin" src="https://github.com/user-attachments/assets/f9751adb-30c7-49a8-bb70-1330e6a03504">

### Requirements

To run GatherPress, we recommend your host supports:
Expand All @@ -92,18 +111,12 @@ To run GatherPress, we recommend your host supports:
- MySQL version 5.6 or greater, or, MariaDB version 10.0 or greater.
- HTTPS support.

## Frequently Asked Questions

### What external services are used in GatherPress?

- Mapping Services: We use OpenStreetMap and Google Maps to display meeting locations on a map. To achieve this, we send the address to OpenStreetMap or Google Maps for rendering.
- Calendar Integration: GatherPress also supports "Add to Calendar" functionality using Google Calendar and Yahoo! Calendar.

### Configure GatherPress
## Configure GatherPress

In WP Admin, go to `Events` > `Settings`.

You can change different settings such as:

- Show publish date as event date for events.
- The default maximum limit of attendees to an event.
- Anonymous RSVP.
Expand Down Expand Up @@ -132,6 +145,7 @@ By default, a few blocks are populated, you can keep them or delete them and you
In WP Admin, go to `Events` > `Venues`.

In the Venue block, you can define:

- The full address, telephone, and website of the venue.
- The map settings.

Expand All @@ -145,43 +159,31 @@ Topics are like post categories, but for events.

If you wish to share in the collaborative of work to build _GatherPress_, please drop us a line either via [WordPress Slack](https://make.wordpress.org/chat/) or on [GatherPress.org](htps://gatherpress.org/get-involved). The development location of the GatherPress project can be found at [https://github.com/gatherpress/gatherpress](https://github.com/gatherpress/gatherpress). All contributions are welcome: code, design, user interface, documentation, translation, and more.

### Read Developer Documentation

Find the developer documentation inside the plugins' `docs` folder or on our [website](https://gatherpress.org/documentation/). our intent is to sync the `docs` folder to the website documentation.

### Collaborator Access

To get write access to the GitHub repo, please reach out to our **GitHub Administrators**: [Mervin Hernandez](https://github.com/MervinHernandez) and [Mike Auteri](https://github.com/mauteri).

To get access to [GatherPress.org](htps://gatherpress.org/get-involved) via SSH or WP Admin login, please reach out to our **GatherPress.org Administrator**: [Mervin Hernandez](https://github.com/MervinHernandez).

### Read Developer Documentation
## Frequently Asked Questions

Find the developer documentation inside the plugins' `docs` folder.
### What external services are used in GatherPress?

### What’s about the PRO version?
- Mapping Services: We use OpenStreetMap and Google Maps to display meeting locations on a map. To achieve this, we send the address to OpenStreetMap or Google Maps for rendering.
- Calendar Integration: GatherPress also supports "Add to Calendar" functionality using Google Calendar and Yahoo! Calendar.

### What about a PRO version?

As a Community powered plugin, GatherPress is already the PRO-version.

Because we strive for close-to-core development, love decisions - not options and follow a lot of well known best-practices within the WordPress space, we can and do focus on what matters most - powering our community's event management needs.

GatherPress‘ best-practices:

- Tested & validated against [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/)
- Not only once, but consequently tested & validated against the [WordPress plugin review guidelines](https://github.com/WordPress/plugin-check-action).
- [JavaScript & PHP Unit tests](https://sonarcloud.io/summary/new_code?id=GatherPress_gatherpress&branch=main) are covering almost 80% of the whole codebase.
- Import & Export event- and venue-data using WordPress' native tools.

### Reminder that GatherPress is still in Alpha

As we continue to refine and develop the plugin, please use the [GatherPress Alpha](https://github.com/GatherPress/gatherpress-alpha) plugin alongside the core GatherPress plugin. The Alpha plugin manages breaking changes easily: just make sure it is up-to-date, activate it, go to the Alpha section under GatherPress Settings, and click "Fix GatherPress!" after updating GatherPress. This process helps us avoid technical debt as we work towards launching version 1.0.0 of the plugin.

## Changelog

See complete changelog at https://github.com/GatherPress/gatherpress/releases.

## Upgrade Notice

### 1.0.0

=======
### Is GatherPress WordPress Multisite compatible?

Yes, GatherPress can be run on a network of sites. The additional database tables it needs, will be created automatically for each new site if the plugin is network-activated.

GatherPress can also be activated per site.
Expand All @@ -192,22 +194,27 @@ As a Community powered plugin, GatherPress is already the PRO-version.

Because we strive for close-to-core development, love decisions - not options and follow a lot of well known best-practices within the WordPress space, we can and do focus on what matters most - powering our community's event management needs.

GatherPress‘ best-practices:
## GatherPress‘ Best Practices:

- Tested & validated against [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/)
- Not only once, but consequently tested & validated against the [WordPress plugin review guidelines](https://github.com/WordPress/plugin-check-action).
- [JavaScript & PHP Unit tests](https://sonarcloud.io/summary/new_code?id=GatherPress_gatherpress&branch=main) are covering almost 80% of the whole codebase.

### Reminder that GatherPress is still in Alpha

As we continue to refine and develop the plugin, please use the [GatherPress Alpha](https://github.com/GatherPress/gatherpress-alpha) plugin alongside the core GatherPress plugin. The Alpha plugin manages breaking changes easily: just make sure it is up-to-date, activate it, go to the Alpha section under GatherPress Settings, and click "Fix GatherPress!" after updating GatherPress. This process helps us avoid technical debt as we work towards launching version 1.0.0 of the plugin.
## Reminder -- GatherPress is still in Alpha

## Changelog
As we continue to refine and develop the core plugin, we've created the [GatherPress Alpha](https://github.com/GatherPress/gatherpress-alpha) plugin to run alongside the GatherPress plugin. The role of the Alpha plugin is to manage breaking changes easily: just make sure it is up-to-date, activate it, go to the Alpha section under GatherPress Settings, and click "Fix GatherPress!" after updating GatherPress. This process helps us avoid technical debt as we work towards launching version 1.0.0 of the plugin. When we arrive there, the Alpha plugin will no longer be necessary.

See complete changelog at https://github.com/GatherPress/gatherpress/releases.
## Screenshots

## Upgrade Notice
1. Create a new event
![Create a new event](.wordpress-org/screenshot-1.png)
2. Create a new venue
![Create a new venue](.wordpress-org/screenshot-2.png)
3. General Settings
![General Settings](.wordpress-org/screenshot-3.png)
4. Leadership Settings
![Leadership Settings](.wordpress-org/screenshot-4.png)

### 1.0.0
## Changelog

See: https://gatherpress.org/releases/version-1-0-0
See complete changelog at https://github.com/GatherPress/gatherpress/releases.