Frontity Docs
  • ยป Welcome to Frontity
  • ๐Ÿš€Getting started
    • Quick start guide
  • ๐Ÿ“ƒAbout Frontity
    • Frontity features
    • Browser support
    • Get involved
  • ๐Ÿ“šCore Concepts
    • 1. Project
    • 2. Settings
    • 3. Packages
    • 4. Roots
    • 5. State
    • 6. Actions
    • 7. Libraries
    • 8. Namespaces
    • 9. Styles
  • ๐Ÿ—๏ธArchitecture
    • Decoupled Mode
    • Embedded Mode
  • ๐ŸŒŽDeployment
    • Deploy Frontity using Vercel
    • Deploy Frontity on Layer0
    • Deploy Frontity on Heroku
  • ๐ŸŒ—Isomorphic React
  • โšก๏ธ Perfomance
    • Caching
    • Link prefetching
    • Lazy Loading
    • Code Splitting
  • ๐Ÿ”ŽSEO
  • ๐Ÿ“–Guides
    • Setting the URL of the WordPress data source
    • Using Environment Variables in a Frontity project
    • WordPress requirements for Frontity
    • URLs in a Migration from WordPress to Frontity Decoupled Mode
    • Frontity Query Options
    • Redirections with Frontity
    • Understanding a Frontity project
    • Add a new Frontity package or theme to your project
    • How to share your Frontity project
    • Understanding Mars Theme
    • Working with processors
    • How to process page-builder content in Frontity
    • Keep Frontity Updated
    • Troubleshooting
    • JavaScript
    • React
  • ๐Ÿ‘Contributing
    • How to contribute?
    • Contributing Guide
Powered by GitBook
On this page
  • Requirements
  • A WordPress installation
  • Node.js

Was this helpful?

Getting started

Previousยป Welcome to FrontityNextQuick start guide

Last updated 4 years ago

Was this helpful?

๐Ÿ‘‹ Welcome! You've just taken your first step on the path to mastering Frontity.

Frontity is a React-based framework that enables you to easily build a frontend for a headless (or decoupled) WordPress site. Your WordPress site serves its data via the REST-API. Frontity framework is open source and free to use.

Requirements

To get started with Frontity you will need:

A WordPress installation

By default Frontity provides an as the data source for every new project, so you can start working with this one.

You can also to be the data source. This can be hosted either locally on your development machine, or on a web-server. You can also use a site hosted on WordPress.com.

Node.js

If you don't already have it you can get Node.js from . This will also install npm and npx along with Node.js.

You will use these to run Frontity commands during the set-up and development of your project.

For those coming from WordPress it might be worth noting that Frontity runs on Node.js, so it needs to be deployed in a different server than your WordPress. If you want to learn more about this, visit Frontity's or see the section arch these docs.

To test if you have Node.js installed open your terminal and run:

node -v
npm -v
๐Ÿš€
example WordPress site
the official site
GitHub repo
Architecture
configure your own WordPress installation