|
| 1 | +# newschin |
| 2 | + |
| 3 | +This project was bootstrapped with [Frontity](https://frontity.org/). |
| 4 | + |
| 5 | +#### Table of Contents |
| 6 | + |
| 7 | +- [Launch a development server](#launch-a-development-server) |
| 8 | +- [Create your custom theme](#create-your-custom-theme) |
| 9 | +- [Create a production-ready build](#create-a-production-ready-build) |
| 10 | +- [Deploy](#deploy) |
| 11 | + |
| 12 | +### Launch a development server |
| 13 | + |
| 14 | +``` |
| 15 | +npx frontity dev |
| 16 | +``` |
| 17 | + |
| 18 | +Runs the app in development mode. Open http://localhost:3000 to view it in the browser. |
| 19 | + |
| 20 | +The site will automatically reload if you make changes inside the `packages` folder. You will see the build errors in the console. |
| 21 | + |
| 22 | +> Have a look at our [Quick Start Guide](https://docs.frontity.org/getting-started/quick-start-guide) |
| 23 | +
|
| 24 | +### Create your custom theme |
| 25 | + |
| 26 | +``` |
| 27 | +npx frontity create-package your-custom-theme |
| 28 | +``` |
| 29 | + |
| 30 | +Use the command `npx frontity create-package` to create a new package that can be set in your `frontity.settings.js` as your theme |
| 31 | + |
| 32 | +> Have a look at our blog post [How to Create a React WordPress Theme in 30 Minutes](https://frontity.org/blog/how-to-create-a-react-theme-in-30-minutes/) |
| 33 | +
|
| 34 | +### Create a production-ready build |
| 35 | + |
| 36 | +``` |
| 37 | +npx frontity build |
| 38 | +``` |
| 39 | + |
| 40 | +Builds the app for production to the `build` folder. |
| 41 | + |
| 42 | +This will create a `/build` folder with a `server.js` (a [serverless function](https://vercel.com/docs/v2/serverless-functions/introduction)) file and a `/static` folder with all your javascript files and other assets. |
| 43 | + |
| 44 | +Your app is ready to be deployed. |
| 45 | + |
| 46 | +> Get more info about [Frontity's architecture](https://docs.frontity.org/architecture) |
| 47 | +
|
| 48 | +### Deploy |
| 49 | + |
| 50 | +With the files generated in the _build_ you can deploy your project |
| 51 | + |
| 52 | +#### As a node app |
| 53 | + |
| 54 | +Use `npx frontity serve` to run it like a normal Node app. |
| 55 | + |
| 56 | +This command generates (and runs) a small web server that uses the generated `server.js` and `/static` to serve your content |
| 57 | + |
| 58 | +#### As a serverless service |
| 59 | + |
| 60 | +Upload your `static` folder to a CDN and your `server.js` file to a serverless service, like Now or Netlify. |
| 61 | + |
| 62 | +> Get more info about [how to deploy](https://docs.frontity.org/deployment) a Frontity project |
| 63 | +
|
| 64 | +--- |
| 65 | + |
| 66 | +### » Frontity Channels 🌎 |
| 67 | + |
| 68 | +We have different channels at your disposal where you can find information about the project, discuss about it and get involved: |
| 69 | + |
| 70 | +- 📖 **[Docs](https://docs.frontity.org)**: this is the place to learn how to build amazing sites with Frontity. |
| 71 | +- 👨👩👧👦 **[Community](https://community.frontity.org/)**: use our forum to [ask any questions](https://community.frontity.org/c/dev-talk-questions), feedback and meet great people. This is your place too to share [what are you building with Frontity](https://community.frontity.org/c/showcases)! |
| 72 | +- 🐞 **[GitHub](https://github.com/frontity/frontity)**: we use GitHub for bugs and pull requests. Questions are answered in the [community forum](https://community.frontity.org/)! |
| 73 | +- 🗣 **Social media**: a more informal place to interact with Frontity users, reach out to us on [Twitter](https://twitter.com/frontity). |
| 74 | +- 💌 **Newsletter**: do you want to receive the latest framework updates and news? Subscribe [here](https://frontity.org/) |
| 75 | + |
| 76 | +### » Get involved 🤗 |
| 77 | + |
| 78 | +Got questions or feedback about Frontity? We'd love to hear from you. Use our [community forum](https://community.frontity.org) yo ! ❤️ |
| 79 | + |
| 80 | +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?](https://docs.frontity.org/contributing/how-to-contribute) |
0 commit comments