ยป Welcome to Frontity

๐Ÿ‘‹ Hi! Welcome to Frontity, and to our documentation pages. This is where you will find all the information you need to build something awesome with Frontity.

Let's kick things off by providing you with a roadmap so that you can find your way around the documentation and zero in on the information you need right now.

About Frontity

To learn about what Frontity is, how it works, and what features it has, visit the About Frontity section.

If you're a developer this section will tell you all about what Frontity is capable of and what you can do with it.

If you're a project manager or other decision maker that needs to choose or justify whether to use Frontity for your project then this section provides the information you need.

Getting Started

If you're new to Frontity then you can get started by heading over to, erm..., the Getting Started section.

This is where you'll find our Quick Start Guide that will get you up and running with Frontity quickly. In particular we would like to draw your attention to the Initial checks section. Make sure you read this before running the installer.

Once you've followed the Quick Start Guide and have a working Frontity installation we'll show you how to connect Frontity up to your own WordPress site and also how to customise the menu to reflect the structure of your WordPress site.

CLI Commands

If you've followed our Getting Started section then you've already used the Frontity CLI to create your first Frontity project. The CLI Commands section is a reference guide to all the other CLI commands that you can use and that can help you during the life-cycle of your project.

Core Concepts

This section is the heart of our documentation. Once you've nailed the basics in the Getting Started section you should head over to the Core Concepts section to really dig in to the detail and learn how to work with Frontity.

Architecture and Deployment

Find out about how the relationship between Frontity and WordPress is structured in the Architecture section. This section will also tell you more about possible hosting solutions.

Deployment

Once you've completed the development of your project and have a working application that you're happy with you can learn how to deploy to live in the Deployment section.

In particular we go into detail on how to deploy to Vercel, our recommended hosting platform. Why do we recommend it? Because it's serverless, cheap, includes a CDN, and is really easy to set up.

Packages

Frontity comes with a number of useful packages for routing, API source, and so on. You can learn all about each of them in the section entitled Packages.

Themes

Really everything is a package when you're working with Frontity.

However a Frontity theme is a special instance of a Frontity package. The included themes, namely Mars and TwentyTwenty, are therefore dealt with separately from the other packages under the Themes section.

WordPress Plugins

The team at Frontity are working on some WordPress plugins that you can install and activate in your WordPress installation. These will help you make the most of headless/decoupled WordPress by adding some useful functionality to the backend.

Learn about the growing list of plugins that can help both enhance your site and make your development easier in the WordPress Plugins section.

Guides

This is where you'll find an ever-growing series of Guides. Some will help you in working with Frontity. Others will give you ideas for projects and provide you with the help you need to guide you from first steps to fully working project.

This is where you can really have fun with Frontity and work toward your stretch goals.

In this section we also provide you with some foundational knowledge that will assist you when working with Frontity. So if you need a refresher, or if you're new to the topics, we have included introductions to JavaScript/ES6 and React in this section.

Our troubleshooting guide is also here, for when you encounter problems. If your problem is not solved here then don't forget that you can also ask it in our Community Forum.

Contributing

Frontity is an open source project and we welcome contributions from the community. The Contributing section of the documentation will guide you whether you want to make a single contribution or whether you intend to become a fully fledged contributor to the Frontity project.

We can't wait to see where you take Frontity in the future.

By the way, we'd love to hear about what you're building with Frontity. Join us in our Community Forum and tell us about your project. You can also ask questions and get help and support from our growing community of users and developers there.

Subscribe to our newsletter here to get notified of the latest news and updates.