This repo will contain all the theme files for the new Mozilla community portal.
- Keep in mind that when you’re serving the site, your server needs to be running at the root of the Wordpress install. The URL in the address bar when you view the site should not contain any sub-directories.
- During development it’s recommended that you use a local URL.
- NOTE: If you have Docker running you may need to quit it, as it may cause port conflicts with Local or your virtual host.
- In a new directory, set up a fresh Wordpress install (wordpress.org)
- Go to the Mozilla community portal repo, and clone or download the theme files. They need to go into the
wp-content/themesdirectory of the Wordpress install you just created. - Navigate to this theme folder in your terminal, and run
npm installto install dependencies. - Run
npm run compileto compile the .scss files and generate astyle.cssfile for the theme, to live update the styles runnpm run watch. - Depending on how you are running Wordpress, you may need to create a new database for the site (or you can use the DB dump at the bottom of this readme).
- Run the site in the browser. Depending on your set up, you may be lead through the typical Wordpress site setup.
- Login to the site as an administrator, and go to
appearance > themesand activate the Mozilla theme. It has no preview screenshot. ## Add the Theme Settings
Go to Mozilla Settings in the left sidebar to add the following settings.
| Setting | Value |
|---|---|
| Report Group / Event Email | <Your email> |
| Github Link | https://github.com/mozilla/community-portal |
| Community Portal Discourse | |
| Mailchimp API Key | <a test API key> |
| Company | Mozilla |
| Address | |
| City | Toronto |
| State / Province | |
| Postal / Zip | |
| Country | |
| Phone | |
| Google Analytics ID | |
| Discourse API Key | |
| Discourse API URL | |
| Discourse URL | (only on production) |
| Mapbox Access Token | |
| Default Open Graph Title | Community Portal - Mozilla |
| Default Open Graph Description | Community Portal - Mozilla |
| Max Image Filesize Upload (KB) | 250 |
| 404 Error Title | Page not Found |
| 404 Error Copy | Oops, we got lost! |
- Next set up the menus
Appearance > Menus:- Create 4 new Menus with the followign items:
- Main
- Sign Up / Log Out (#)
- Search (#)
- Mozilla
- About (#)
- Mission (#)
- Contact (#)
- Donate (#)
- Mozilla Main Menu
- Campaigns (/campaigns)
- Activities (/activities)
- Events (/events)
- Groups (/groups)
- People (/people)
-
- Assign this menu to the Display locations of ‘Mozilla Custom Theme Menu’
- Resources
- Code of Conduct (#)
- Privacy Policy (#)
- Creative License (#)
- Legal Notices (#)
- Main
- Create 4 new Menus with the followign items:
This is MySQL dump with credentials as admin/password with admin rights and plugins configured (as this readme) with some example events as host community.test.
- Once the site is created, the following plugins need to be installed:
- Auth0 (only on production)
- BuddyPress
- Events Manager (for BuddyPress)
- ACF Pro (free version works)
- WPML (works not always without but in case of error is enough to remove
/en/from the URL)
- Only for development
Events Manager require a patch as doesn't allow with a filter to change the Booking Cut off date, as we need that the last day to attend is the last event day (+1 months as we have people that forgot to mark their participation) this requires a patch to classes/em-events.php.
Changes to do with 6.3 release diff:
585a586
> $this->event_rsvp_date = gmdate( 'Y-m-d', strtotime( '+1 months', strtotime( $this->event_end_date ) ) );
773a775
> $this->event_rsvp_date = gmdate( 'Y-m-d', strtotime( '+1 months', strtotime( $this->event_end_date ) ) );
907a910
> $this->event_rsvp_date = gmdate( 'Y-m-d', strtotime( '+1 months', strtotime( $this->event_end_date ) ) );
1568a1572
> $this->event_rsvp_date = gmdate( 'Y-m-d', strtotime( '+1 months', strtotime( $this->event_end_date ) ) );
3104a3109
> $event['event_rsvp_date'] = gmdate( 'Y-m-d', strtotime( '+1 months', strtotime( $event['event_end_date'] ) ) );
Support request: https://wordpress.org/support/topic/force-a-specific-event_rsvp_date-with-an-hook/, https://wordpress.org/support/topic/force-a-specific-event_rsvp_date-with-an-hook-again/
- Before creating pages, activate BuddyPress. This will automatically create some pages, and reduce those you need to manually create
| Page Name | URL Slug | Page Parent |
|---|---|---|
| Activate | /activate |
n/a |
| Community Portal | set to front page in Settings > Reading |
n/a |
| Events | /events |
n/a |
| Categories | /categories |
Events |
| Edit | /edit |
Events |
| Locations | /locations |
Events |
| My Bookings | /my-bookings |
Events |
| Tags | /tags |
Events |
| Groups | /groups |
n/a |
| Members | /people |
n/a |
| Register | /register |
n/a |
- Go to the Plugins page and activate the Auth0 plugin
- In 1password there is a
domain,client IDandclient Secretin the secure note - configure the plugin with this information.
- Activate BuddyPress if you have not already
- Go to Plugins > BuddyPress > Settings
- Components Tab
- everything except ‘Site Tracking’ should be enabled
- Options Tab
- Set the template to ‘BuddyPress Legacy’
- everything else here should be checked except for ‘Post Comments’
- Pages Tab
- Set Members -> Members
- Set Activity Streams -> Activity
- Set User Groups -> Groups
- Activate the plugin
- Import the ACF fields
- Go to
Custom Fields > Tools - We’re going to import the field settings via a JSON import
- In the theme files, there is a top-level directory called ACF, this contains JSON files with the info ACF needs to set up our fields
- Under
Import Field Groupschoose the oldest file in this directory and import it. - Repeat this step for the remaining files, in chronological order.
- Go to
Require various plugin settings and also to check the code about what is doing. The first step is required that you user accept the T&C or you cannot create events.
composer update # To download PHPCS
./vendor/bin/phpcs --standard=WordPress .
./vendor/bin/phpcbf --standard=WordPress .
Using VVV copy the file default-config.yml as config.yml in the same folder.
Next in the sites section in the YAML file add:
community:
repo: https://github.com/Varying-Vagrant-Vagrants/custom-site-template
custom:
delete_default_plugins: true
install_plugins:
- query-monitor
- classic-editor
- buddypress
- events-manager
- advanced-custom-fields
wpconfig_constants:
WP_DEBUG: true
WP_DEBUG_LOG: wp-content/debug.log
WP_DISABLE_FATAL_ERROR_HANDLER: true
nginx_upstream: php73
hosts:
- community.test
Download the sample data above in this readme, put in the VVV/database/sql/backups/ folder as community.sql.gz.
Now you can launch in the terminal vagrant up (check the documentation to install VVV).
After running you will have a working dev environment with database and plugins configured.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent