Skip to content

adituriya/earth-calendar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Earth Calendar

A circular calendar that shows the Earth's position in its orbit around the Sun.

Installation

The calendar is bundled as a WordPress plugin, and has one dependency.

It depends on Advanced Custom Fields. Install and activate the ACF plugin using the WordPress admin.

Once installed, use Custom Fields - Tools to import the acf/acf-export.json file from this project.

To install the calendar itself, this project needs to be built using the instructions below. This will generate a release/earth-calendar.zip file, which can be uploaded to your WordPress site.

Usage

  1. Add important Dates using the WordPress admin (the plugin adds a custom post type: Calendar Date). Ensure that each date has a Year assigned ('Year' is a custom taxonomy, and is used to filter dates: it should be set to either 'Yearly' or a specific year). Dates with no 'Year' assigned will not be displayed on the calendar.

  2. Finally, use the [earth_calendar] shortcode on any WordPress post or page. You can add your own introductory text or instructions; the shortcode merely outputs the current date and the rendered SVG drawing.

Development

You will need a recent version of Node (and NPM) installed locally. I recommend using NVM to install Node, as it makes it easy to switch between different versions.

Set up a local WordPress development environment using your method of choice (VVV, Chassis, Local, etc.) You can skip this step if you are only building the plugin (and don't need to test it locally).

With your local development site up and running, navigate to the WordPress plugins directory and clone this repository. If you are only building, you can clone it to any convenient location.

cd (...)/wp-content/plugins
git clone https://github.com/adituriya/earth-calendar.git

Install project dependencies using npm install from within the project directory:

cd earth-calendar
npm install

Then, you can launch Rollup in watch mode using

npm run dev

CTRL+C will halt watch mode. Finally, to build a .zip release,

npm run build

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published