dsawardekar / frontity-embedded

Embedded Mode plugin for Frontity sites

Home Page:https://frontity.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Frontity - Embedded Mode

For a full explanation please refer to the Embedded mode documentation. If you have any questions related to the plugin feel free to share them in Frontity community forum.

Install

  1. First of all you have to install the plugin. You can do it:
    • Automatic: from within WordPress dashboard go to Plugins, click Add New button, search for Frontity Embedded Mode by Frontity and click Install Now.
    • Manual: this method requires to download the plugin and upload it to your web server via FTP. For a more detailed explanation, WordPress explains how to do this on this guide.
  2. Once installed, you have to activate it, go to Settings -> Frontity Embedded Mode, and define the proper Frontity Server Url. and it will be running!

Environment Variables

You can also use an environment variable instead of changing the URL in the plugin interface.

> FRONTITY_SERVER=https://myfrontityserver.com

WordPress Constant

Lastly a PHP constant can be defined. This would usually be done in the wp-config.php file.

define( 'FRONTITY_SERVER', 'https://myfrontityserver.com' );

Note that if the PHP constant exists, it takes precedence over both the environment variable and the settings page setting.

Static Assets

If you need, you can change the folder or URL where your static assets are stored using the --public-path option of the npx frontity build command.

Example: Frontity in the same WordPress server

If you are using the same server for both WordPress and Frontity, and your Frontity project is at /wp-content/frontity, your static folder will be at https://yourdomain.com/wp-content/frontity/build/static.

You can change the folder when you run npx frontity build like this:

> npx frontity build --public-path /wp-content/frontity/build/static

Example: Frontity in an external server

If you deployed Frontity in an external hosting service, like for example Vercel, you can use the --public-path option to point directly to the Vercel URL:

> npx frontity build --public-path https://myfrontityapp.now.sh/static

Local Development

If you want to use the Embedded mode while you are developing in your local environment, you can do so by using the --public-path parameter in the npx frontity dev command as well:

> npx frontity dev --public-path http://localhost:3000/static

Frontity Channels 🌎

Community Forum Topics Twitter: frontity Frontity Github Stars

We have different channels at your disposal where you can find information about the Frontity project, discuss it and get involved:

  • πŸ“– Docs: this is the place to learn how to build amazing sites with Frontity.
  • πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Community: use our forum to ask any questions, feedback and meet great people. This is your place too to share what are you building with Frontity!
  • 🐞 GitHub: we use GitHub for bugs and pull requests. Questions are answered in the community forum!
  • πŸ—£ Social media: a more informal place to interact with Frontity users, reach out to us on Twitter.
  • πŸ’Œ Newsletter: do you want to receive the latest framework updates and news? Subscribe here

Β» Get involved πŸ€—

Got questions or feedback about Frontity? We'd love to hear from you. Use our community forum yo ! ❀️

Frontity also welcomes contributions. There are many ways to support the project! If you don't know where to start, this guide might help: How to contribute?

About

Embedded Mode plugin for Frontity sites

https://frontity.org


Languages

Language:PHP 100.0%