malte-j / argo

Argo, the WordPress Theme for Spacifik.de. Utilizing Docker, Webpack, etc. to make development a breeze.

Home Page:https://spacifik.de

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Argo, the WordPress Theme for Spacifik.de

spacifik_preview_4

Developed from the ground up and packed full with features, including:

πŸ“¦ SASS and JS bundling using webpack

🐳 Docker environment for local development

πŸ’¨ Lottie animation support for tiny and incredibly performant animations

πŸ”₯ Hot reload across multiple devices using webpack and browsersync

βš“ plugin synchronization through docker mount

βœ‰οΈ contact form utilizing AWS Lambda

πŸ”ƒ CI & CD using GitHub actions

πŸ“± JS library for syncing Lottie animations to scroll

 

Setting up Argo

The following assumes that you've already installed docker and node on your local machine.

First you setup docker, for that you just need to execute docker-compose up. This starts a WordPress instance on port 8000. You can already configure it if you want, but the theme won't yet show up.

After that, you need to install your node dependencies. Navigate to themes/argo and run npm i. Then you can build the theme for the first time. Using npm run watch you can start the development server, or just run npm run pack to build it once. Now the theme should show up as available in your WordPress install.

 

Using Argo

Once you've set the theme up once, you can use the start.shand stop.sh scripts in the root folder to start and stop docker and the live server more easily.

If you want to generate a zip file for uploading it to a different WordPress instance, you can run npm run build in the themes/argo folder. This will build the theme and generate an argo.zip file in the root folder.

 

Working with CI/CD (Contributors only)

All releases will be built by GitHub actions, the generated zip files are available in the releases section.

Workflow for releasing a new version of Argo:

Step Command Result
1. git add . Add files to commit
2. git commit -m "message for commit" Commit files
3. git tag v1.0.0 -m "message for tag" Tag version
4. git push --follow-tags Push commit along with tags

About

Argo, the WordPress Theme for Spacifik.de. Utilizing Docker, Webpack, etc. to make development a breeze.

https://spacifik.de


Languages

Language:PHP 71.3%Language:JavaScript 26.8%Language:SCSS 1.6%Language:CSS 0.2%Language:Hack 0.0%Language:Shell 0.0%