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.

Sign up for GitHub

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

Keep a DRY README.md for wordpress.org & Github #653

Merged
merged 26 commits into from
May 18, 2024
Merged

Keep a DRY README.md for wordpress.org & Github #653

Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
60526e3
Update file header (following https://raw.githubusercontent.com/johnb…
carstingaxion May 4, 2024
153ddbf
Update section headlines to follow WordPress guidelines
carstingaxion May 4, 2024
d50b61e
Move developer docs into separate file
carstingaxion May 4, 2024
0037a15
Re-Order existing content to better fit WordPress' sections
carstingaxion May 4, 2024
f696faa
Move 'Requirements' into 'Installataion' section
carstingaxion May 4, 2024
e4dad5c
Add hint about external services (#610)
carstingaxion May 4, 2024
5bdbe49
Show the demo-video on wp.org/plugins
carstingaxion May 4, 2024
d574738
Move 'Screenshots' section below 'Description' to show images earlier…
carstingaxion May 4, 2024
6f4292a
Remove readme.txt in favor of README.md
carstingaxion May 4, 2024
88dfae2
Add links to issues of upcoming features to interest and engage peopl…
carstingaxion May 4, 2024
e910034
Fix URL
carstingaxion May 4, 2024
6df3b9d
Remove italic formatting for the plugin name
carstingaxion May 4, 2024
287f8bf
Fix missing new line after shortcode
carstingaxion May 4, 2024
e00ded4
Link to the (not yet existend) glotpress page
carstingaxion May 4, 2024
3732945
Remove superfluous comma
carstingaxion May 4, 2024
fc96f4e
Update 'Contributors' to be Leaders & Team of GatherPress
carstingaxion May 5, 2024
4957995
Update 'Credits' to be Leaders & Team of GatherPress
carstingaxion May 5, 2024
99352ac
New FAQ: "What’s about the PRO version?"
carstingaxion May 9, 2024
520e115
NEW paragraph about Pilot (in bold, due to the lack of quote-markup o…
carstingaxion May 9, 2024
564c150
Remove #comment-31591 from URL.
carstingaxion May 13, 2024
8af5595
NEW list of 3rd-parties as suggested by @jmarx in #657
carstingaxion May 13, 2024
d08d09a
Remove line-break
carstingaxion May 13, 2024
b6caf21
NEW line break
carstingaxion May 13, 2024
98b3d18
Remove 3rd parties, which are not packaged with the plugin.
carstingaxion May 14, 2024
7ce7f8c
Updated FAQ for external services.
mauteri May 18, 2024
a4e7694
Merge branch 'main' of github.com:GatherPress/gatherpress into README.md
mauteri May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
181 changes: 70 additions & 111 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# GatherPress

> GatherPress, powering our community's event management needs.
Stable tag: 0.29.0-alpha
Tested up to: 6.5.2
License: GPL v2 or later
Tags: events, event, meetup, community
Contributors: mauteri, hrmervin, patricia70, jmarx, pbrocks, prashantabellad, prayagm, javiercasares, linusx007, meaganhanes, stephenerdelyi, nilovelez, carstenbach

![](.wordpress-org/banner-1544x500.jpg)

GatherPress, powering our community's event management needs.

![GPLv2 License](https://img.shields.io/github/license/GatherPress/gatherpress) [![Coding Standards](https://github.com/GatherPress/gatherpress/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/coding-standards.yml) [![PHPUnit Tests](https://github.com/GatherPress/gatherpress/actions/workflows/phpunit-tests.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/phpunit-tests.yml) [![JavaScript Unit Tests](https://github.com/GatherPress/gatherpress/actions/workflows/jest-tests.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/jest-tests.yml) [![E2E Tests](https://github.com/GatherPress/gatherpress/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/e2e-tests.yml) [![SonarCloud](https://github.com/GatherPress/gatherpress/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/sonarcloud.yml) [![Dependency Review](https://github.com/GatherPress/gatherpress/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/GatherPress/gatherpress/actions/workflows/dependency-review.yml)

Expand All @@ -10,17 +18,22 @@

![WordPress Plugin Active Installs](https://img.shields.io/wordpress/plugin/installs/gatherpress) ![WordPress Plugin Downloads](https://img.shields.io/wordpress/plugin/dt/gatherpress) ![WordPress Plugin Rating](https://img.shields.io/wordpress/plugin/rating/gatherpress)

## Overview
## Description

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/)

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're creating the very network features we need to host events and gather well.

[video src="https://raw.githubusercontent.com/GatherPress/gatherpress/main/docs/media/GatherPress-demo-20240218.mp4"]

![Demo](docs/media/GatherPress-demo-20240218.mp4)

## Features
### Features

- Event Scheduling: set dates, times, and provide event information details.
- Attendee registration.
Expand All @@ -36,27 +49,55 @@ We're creating the very network features we need to host events and gather well.

### Upcoming features

- Allow attendees to add guests.
- Import events from meetup.com with an add-on plugin (currently in development).
- Recurring events.
- Calendar block.
- Email notification when event starts.
- Allow attendees to add guests. ([#](https://github.com/GatherPress/gatherpress/issues/86))
- Import events from meetup.com with an add-on plugin. ([#](https://github.com/GatherPress/gatherpress/issues/394))
- Recurring events. ([#](https://github.com/GatherPress/gatherpress/issues/80))
- Calendar block. ([#](https://github.com/GatherPress/gatherpress/issues/369))
- 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:

- [React-Modal](https://github.com/reactjs/react-modal): Facilitates the creation of modal dialogs in React components.
- [React-Tooltip](https://github.com/wwayne/react-tooltip): Provides customizable tooltips for React applications.


### Credits

Thanks to the following folks for contributing to GatherPress:
[Mike Auteri](https://profiles.wordpress.org/mauteri/), [Mervin Hernandez](https://profiles.wordpress.org/hrmervin/), [Patricia BT](https://profiles.wordpress.org/patricia70/), [jmarx](https://profiles.wordpress.org/jmarx/), [Paul Barthmaier (pbrocks)](https://profiles.wordpress.org/pbrocks/), [prashantabellad](https://profiles.wordpress.org/prashantabellad/), [Prayag Mankar](https://profiles.wordpress.org/prayagm/), [Javier Casares](https://profiles.wordpress.org/javiercasares/), [linusx007](https://profiles.wordpress.org/linusx007/), [meagan hanes](https://profiles.wordpress.org/meaganhanes/), [Steve Erdelyi](https://profiles.wordpress.org/stephenerdelyi/), [Nilo Velez](https://profiles.wordpress.org/nilovelez/) & [Carsten Bach](https://profiles.wordpress.org/carstenbach/)

carstingaxion marked this conversation as resolved.
Show resolved Hide resolved

## Screenshots

## Requirements

To run GatherPress, we recommend your host supports:

- PHP version 7.4 or greater.
- MySQL version 5.6 or greater, or, MariaDB version 10.0 or greather.
- HTTPS support.

## Installation

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.
3. Activate the plugin.

## How to Use
### Requirements

To run GatherPress, we recommend your host supports:

- PHP version 7.4 or greater.
- MySQL version 5.6 or greater, or, MariaDB version 10.0 or greather.
- HTTPS support.

## Frequently Asked Questions

### What external services are used in GatherPress?

We utilize Open Street Maps to render meeting locations in a map form. In order to do so we send the address to OSM in order to render their map.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add Google maps to this as well as Yahoo! and Google calendar in the add to calendar functionality.


### Configure GatherPress

Expand Down Expand Up @@ -100,117 +141,35 @@ In WP Admin, go to `Events` > `Topics`.

Topics are like post categories, but for events.

## 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](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.

### Collaborator Access
### Get 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).

## Developer Documentation
### Read Developer Documentation

### .wp-env
Find the developer documentation inside the plugins' `docs` folder.

If you have Docker installed, you could use the `wp-env` package to load a WordPress development environment with this plugin automatically activated.
### What’s about the PRO version?

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

#### Fork this repository
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.

Although you can download a zip file of the plugin at:
GatherPress‘ best-practices:

```
https://github.com/GatherPress/gatherpress
```
- 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.

If you want to help out with development, we suggest forking the code to your own Github repository and creating a branch from there.

#### Clone this repository
## Changelog

Once you've forked the repo, you should now have a mirrored copy of GatherPress, but on your profile's URL, or something like this:
See complete changelog at https://github.com/GatherPress/gatherpress/releases.

```
https://github.com/YourGithubUsername/gatherpress
```
## Upgrade Notice

where `YourGithubUsername` corresponds to your login name for Github.
### 1.0.0

To clone a local copy, open a terminal window and run the following command:

```sh
git clone git@github.com:YourGithubUsername/gatherpress.git
```

if you have your SSH keys set up. If not, run:

```sh
git clone https://github.com/YourGithubUsername/gatherpress.git
```

##### Note about customizing the URL

Once you have forked the GatherPress repo, you can also change the folder name of your version of the repository by going into your settings of your repo on Github's website.

```
https://github.com/pbrocks/gatherpress
```

![PBrocks GatherPress repo](docs/media/pbrocks-gatherpress.png)

### Install wp-env globally

In a terminal window, run:

```sh
npm i -g @wordpress/env
```

#### Change directory and run wp-env

In your terminal window, run:

```sh
cd gatherpress
wp-env start
```

You should then see that a development site has been configured for you on localhost port 2003

![Development Site Login](docs/media/wp-env.json-startup.png)

#### Log in to Site / Log into Site

![Development Site Login](docs/media/dev-login-gatherpress.png)

#### Development Site Plugins/Themes

To further customize the development site using your favorite or most familiar development plugins or themes, you are able to add whatever you like because of this code added to the `.wp-env.json` file:

```json
"mappings": {
"wp-content/plugins": "./wp-core/plugins",
"wp-content/themes": "./wp-core/themes"
},
```

In fact, after the initial setup, you may notice that in your code editor, there is now a `wp-core` folder containing the default plugins and themes, but it is grayed out, so the contents of this folder will not be committed to the GatherPress repository.

![Development Site Plugins/Themes](docs/media/gitignore—gatherpress.png)

#### To shut down your development session

Simply run:

```sh
wp-env stop
```

For more info on wp-env package, consult the [Block Handbook's page](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/).

## Credits

Thanks to the following folks for contributing to GatherPress:
[mauteri](https://profiles.wordpress.org/mauteri/), [hrmervin](https://profiles.wordpress.org/hrmervin/), [pbrocks](https://profiles.wordpress.org/pbrocks/), [jmarx](https://profiles.wordpress.org/jmarx/), [prashantabellad](https://profiles.wordpress.org/prashantabellad/), [prayagm](https://profiles.wordpress.org/prayagm/), [patricia70](https://profiles.wordpress.org/patricia70/), [meaganhanes](https://profiles.wordpress.org/meaganhanes/), [calebthedev](https://profiles.wordpress.org/calebthedev/), [javiercasares](https://profiles.wordpress.org/javiercasares/), [linusx007](https://profiles.wordpress.org/linusx007/), [cameronbarrett](https://profiles.wordpress.org/cameronbarrett/), [courane01](https://profiles.wordpress.org/courane01/), [newyorkerlaura](https://profiles.wordpress.org/newyorkerlaura/), [phoopee3](https://profiles.wordpress.org/phoopee3/), [hauvong](https://profiles.wordpress.org/hauvong/), [deshabhishek007](https://profiles.wordpress.org/deshabhishek007/), [jeffpaul](https://profiles.wordpress.org/jeffpaul/), [michelleames](https://profiles.wordpress.org/michelleames/)
See: https://gatherpress.org/releases/version-1-0-0
99 changes: 99 additions & 0 deletions docs/developer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
## Developer Documentation

### .wp-env

If you have Docker installed, you could use the `wp-env` package to load a WordPress development environment with this plugin automatically activated.

### Local Development

#### Fork this repository

Although you can download a zip file of the plugin at:

```
https://github.com/GatherPress/gatherpress
```

If you want to help out with development, we suggest forking the code to your own Github repository and creating a branch from there.

#### Clone this repository

Once you've forked the repo, you should now have a mirrored copy of GatherPress, but on your profile's URL, or something like this:

```
https://github.com/YourGithubUsername/gatherpress
```

where `YourGithubUsername` corresponds to your login name for Github.

To clone a local copy, open a terminal window and run the following command:

```sh
git clone git@github.com:YourGithubUsername/gatherpress.git
```

if you have your SSH keys set up. If not, run:

```sh
git clone https://github.com/YourGithubUsername/gatherpress.git
```

##### Note about customizing the URL

Once you have forked the GatherPress repo, you can also change the folder name of your version of the repository by going into your settings of your repo on Github's website.

```
https://github.com/pbrocks/gatherpress
```

![PBrocks GatherPress repo](../media/pbrocks-gatherpress.png)

### Install wp-env globally

In a terminal window, run:

```sh
npm i -g @wordpress/env
```

#### Change directory and run wp-env

In your terminal window, run:

```sh
cd gatherpress
wp-env start
```

You should then see that a development site has been configured for you on localhost port 2003

![Development Site Login](../media/wp-env.json-startup.png)

#### Log in to Site / Log into Site

![Development Site Login](../media/dev-login-gatherpress.png)

#### Development Site Plugins/Themes

To further customize the development site using your favorite or most familiar development plugins or themes, you are able to add whatever you like because of this code added to the `.wp-env.json` file:

```json
"mappings": {
"wp-content/plugins": "./wp-core/plugins",
"wp-content/themes": "./wp-core/themes"
},
```

In fact, after the initial setup, you may notice that in your code editor, there is now a `wp-core` folder containing the default plugins and themes, but it is grayed out, so the contents of this folder will not be committed to the GatherPress repository.

![Development Site Plugins/Themes](../media/gitignore—gatherpress.png)

#### To shut down your development session

Simply run:

```sh
wp-env stop
```

For more info on wp-env package, consult the [Block Handbook's page](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/).
Loading
Loading