Atlas: Headless WP

A Local add on for developing headless WordPress websites.

Manual Installation & Development setup

If you haven't already, it is advised that you familiarize yourself with the basics of electron.

Clone

Clone the repository into one of the following directories depending on your platform:

macOS: ~/Library/Application Support/Local/addons
Windows: C:\Users\username\AppData\Roaming\Local\addons
Linux: ~/.config/Local/addons

You need to replace 'Local' with 'Local Beta' in the above paths if you want to create the add-on for Local Beta.

If you prefer to clone your source code elsewhere, you can do so and then symlink that directory to one in the above mentioned directories.

An example of this on MacOS would look like:

git clone git@github.com:getflywheel/local-addon-headless.git ~/code

ln -s ~/code/local-addon-headless ~/Library/Application Support/Local/addons

Install Add-on Dependencies

yarn install or npm install

Build

This add-on utilizes tsc to compile the Main thread code and webpack to compile the Renderer thread code.

to compile both at the same time run:

yarn build

Otherwise you can compile the main thread code with:

yarn build-main

Or the renderer thread code with:

yarn build-renderer or yarn watch-renderer

Add Add-on to Local

Clone repo directly into the add-ons folder (paths described above)
yarn install or npm install (install dependencies)
yarn build or npm run build
Open Local and enable add-on

Another option for testing this add-on in Local is to run `npm pack` in the root dir of this repo. Then, open Local and install the add-on from disk using the newly created `.tgz` file. Don't forget to enable the add-on afterwards!

External Libraries

@getflywheel/local provides type definitions for Local's Add-on API.
- Node Module: https://www.npmjs.com/package/@getflywheel/local-components
- GitHub Repo: https://github.com/getflywheel/local-components

It is worth noting the the TS definitions for this module are exposed and publicly availble. The actual code is injected once the add-on is loaded by Local. This can make writing tests a little tricky as the @getflywheel/local/<main/renderer> module isn't available outside of Local (ie testing unit testing environments). The best option is to mock out this module while running tests.

@getflywheel/local-components provides reusable React components to use in your Local add-on.
- Node Module: https://www.npmjs.com/package/@getflywheel/local
- GitHub Repo: https://github.com/getflywheel/local-addon-api
- Style Guide: https://getflywheel.github.io/local-components

Folder Structure

All files (other than test files) in /src will be transpiled to /lib using TypeScript. Anything in /lib will be overwritten.

vendor contains compiled binaries namespaced under the appropriate operating system name.

Development Workflow

If you are looking for help getting started, you can consult the documentation for the add-on generator.

You can consult the Local add-on API, which provides a wide range of values and functions for developing your add-on.

License

MIT

getflywheel/local-addon-atlas