Skip to content

Latest commit

 

History

History
80 lines (46 loc) · 3.9 KB

README.md

File metadata and controls

80 lines (46 loc) · 3.9 KB
Raw

hello-frontity

This project was bootstrapped with Frontity.

Table of Contents

Launch a development server

npx frontity dev

Runs the app in development mode. Open http://localhost:3000 to view it in the browser.

The site will automatically reload if you make changes inside the packages folder. You will see the build errors in the console.

Have a look at our Quick Start Guide

Create your custom theme

npx frontity create-package your-custom-theme

Use the command npx frontity create-package to create a new package that can be set in your frontity.settings.js as your theme.

Have a look at our blog post How to Create a React WordPress Theme in 30 Minutes

Create a production-ready build

npx frontity build

Builds the app for production to the build folder.

This will create a /build folder with a server.js (a serverless function) file and a /static folder with all your javascript files and other assets.

Your app is ready to be deployed.

Get more info about Frontity's architecture

Deploy

With the files generated in the build you can deploy your project.

As a node app

Use npx frontity serve to run it like a normal Node app.

This command generates (and runs) a small web server that uses the generated server.js and /static to serve your content.

As a serverless service

Upload your static folder to a CDN and your server.js file to a serverless service, like Vercel or Netlify.

Get more info about how to deploy a Frontity project

Frontity Community

Community Forum Topics Twitter: frontity Frontity GitHub Stars

👋  We'd love for you to be part of the Frontity community. There are a variety of different ways in which you can find more information about the project, join in discussions about it, and also get involved:

  • Learn Frontity: in this page you can find Frontity's primary learning resources, including documentation resources, example projects, videos, and more.
  • Community forum: Frontity's forum is a great place to ask questions, help fellow Frontity users, and share your projects. It's also where you can keep track of the development work, join feature discussions, and collaborate on building Frontity itself.
  • GitHub: for bug reports and code contributions. Questions are answered in the community forum.

If you're looking for news and updates about Frontity, Twitter and the blog are pretty good places to start. You can also join the Frontity Newsletter and stay updated on new releases and features, learning resources, and community news.

Contributing

Frontity welcomes contributions in all forms. There are many different ways to support the project. Check out the How to contribute page for ideas on contributing and helping make Frontity better.