https://github.com/mfleming711/virgin-pulse
https://github.com/mfleming711/virgin-pulse
gsap react tailwindcss wordpress
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mfleming711/virgin-pulse
- Owner: mfleming711
- Created: 2024-10-17T08:27:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T17:35:32.000Z (over 1 year ago)
- Last Synced: 2025-04-07T01:51:33.597Z (about 1 year ago)
- Topics: gsap, react, tailwindcss, wordpress
- Language: Twig
- Homepage: https://personifyhealth.com/
- Size: 2.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# pulse_theme
This is a custom WordPress theme based on [Timber](https://timber.github.io/docs/v1/guides/cheatsheet/), [ACF](https://www.advancedcustomfields.com/resources/blocks/) Gutenberg Blocks, [Alpine.js](https://alpinejs.dev/start-here), and [Tailwind](https://tailwindcss.com/docs/installation).
## Local Setup
The repo contains all files required for a valid WordPress Theme right in the root directory. When setting up a local WP installation (via [LocalWP](https://localwp.com/) for example) the entire folder can be symlinked into the themes directory like this:
```
# Mac/Ubuntu:
ln -s /Users/username/projects/virgin-pulse /Users/username/LocalSites/virginpulse/app/public/wp-content/themes/pulse_theme
```
```
# Windows:
MKLINK /J "D:\LocalSites\virginpulse\app\public\wp-content\themes\pulse_theme" D:\projects\virgin-pulse
```
> [!IMPORTANT]
> It is assumed in several places that the theme folder's name will be `pulse_theme`.
## Running the Project
Install dev PHP dependencies using [Composer](https://getcomposer.org/download/) with `composer install`
Install dev JS dependencies using yarn with `nvm use && yarn`
A local dev server to build and watch files can be started via: `yarn dev`.
New components can be generated via `yarn plop component`.
## Building and Deployment
An optimized version of the theme, with minified images, css and js files will be copied into the `dist/` folder when running `yarn build`.
The contents of `dist/pulse_theme` can then be deployed to your hosting provider of choice. Alternatively the generated `dist/vustion_theme.zip` can be uploaded via the Admin Panel, to update/overwrite the theme on demand.
## Environment Variables (TBD)
The following Constants can be set in the `wp-config.php` to allow for different configurations between development, staging and production environments:
```
# ENV VARS
define( '', '' );
```