How to share your Frontity project
When you create a Frontity project most of the times you'll end up creating a custom theme:
- Because you need some specific design and features for your project
- Because you directly want to create a theme that can be reused by others (like @frontity/mars-theme or @frontity/twentytwenty-theme)
Whatever the case is, you may want the community:
- To be able to check the code of your theme
- To be able to install it locally so it can be debugged → this will help the community to help you with any issue you may have with your project/theme
- To be able to install it as an npm package (eventually) so it can be easily reused in some other projects
Here you have a few things to consider to ease contributions and support from the community to your theme
A Frontity theme project structure
In Frontity, themes are packages that can be published in npm so they can be installed and used in any other Frontity project
The suggested structure for developing new themes that works with Frontity is the following one
1
/my-frontity-project
2
|__ frontity.settings.js
3
|__ package.json
4
|__ /node_modules
5
|__ /packages
6
|__ /awesome-theme
7
|__ /my-custom-extension-1
8
|__ /my-custom-extension-2
Copied!
This is the structure we recommend you to upload to your remote git repository (Github, Bitbucket or any other)
Examples:
In this structure, the theme you're developing is a local dependency of the main
package.json1
"dependencies": {
2
"awesome-theme": "file:packages/awesome-theme"
3
}
Copied!
This type of dependency is automatically defined if you create the package (theme) w/ the Frontity command
npx frontity create-package awesome-theme
» Read more about frontity create-packageThis structure implies having a main Frontity project (root
package.json) and some packages (each one with its own package.json) under the packages folder1
/my-frontity-project
2
...
3
|__ package.json
4
...
5
|__ /packages
6
|__ /awesome-theme
7
|__ /my-custom-extension-1
8
|__ /my-custom-extension-2
Copied!
So, to create a custom theme project we recommend you to:
- 1.Create a Frontity project →
npx frontity create awesome-theme-project - 2.Create a Frontity package (your theme) →
npx frontity create-package awesome-theme
These files in the root represents the Frontity project that can be launched and that will allow to see the theme (or any other package) in action
In the root folder you'll find the following:
frontity.setting.js
frontity.setting.jsA
frontity.setting.js file containing the settings for your project (among other settings you'll usually define the use of this theme)For example:
1
...
2
"packages": [
3
{
4
"name": "awesome-theme"
5
},
6
...
Copied!
node_modules
node_modulespackages
packagespackage.json
package.jsonThis
package.json is used when you publish a package in npm, but this Frontity project is not meant to be publishedNotice the
"private": true preventing this package (the main Frontity project defined in the root) being publishedThe Theme
With this structure you can develop your theme as a package inside the
packages folder.Each one of these packages will have its own
package.json and these packages are the ones meant to be published (npm publish)In Frontity you can create a new package by doing
npx frontity create-package <my package name> (from the root of the Frontity project)
» Read more about frontity create-packageWhy this structure?
This structure allows to:
- Launch the project using the theme locally
- Publish the theme independently
So any developer can clone this project, launch the Frontity project locally, have a look at how the theme looks like & behave and make contributions (pull requests) to your repository (that can be eventually merged into the main repository).
And also, the owner of the theme still can publish those new updates independently (from the theme folder,
packages/awesome-theme in this case)Sharing your GitHub repository on CodeSandbox
GitHub repositories containing Frontity projects with the structure explained above, can be directly opened in CodeSandbox by using one of the following URL structures:
1
https://githubbox.com/<%GITHUB_ACCOUNT%>/<%FRONTITY_PROJECT_REPOSITORY%>
2
https://codesandbox.io/s/github/<%GITHUB_ACCOUNT%>/<%FRONTITY_PROJECT_REPOSITORY%>
Copied!
For example this repo https://github.com/frontity-demos/demo-custom-homepage-categories can be opened directly in CodeSandbox with links like:
Example: Frontity Chakra Theme
- In a GitHub repository ready to be cloned and launched locallly, and also ready to accept contributions from the community via Pull Requests
Clone and launch it locally
1
/frontity-chakra-ui-theme
2
|__ frontity.settings.js
3
|__ package.json
4
...
5
|__ /packages
6
|__ /frontity-chakra-theme
Copied!
From the root of the project we can do
1
npm install
Copied!
This command will install the dependencies of the Frontity project and the dependencies of its dependencies, just as any other npm package
1
"dependencies": {
2
...
3
"frontity-chakra-theme": "./packages/frontity-chakra-theme"
4
}
Copied!
All needed dependencies (the ones defined for the Frontity project and the ones defined for the theme) are installed
Once we have all the dependencies installed you can do (from the root)
1
npx frontity dev
Copied!
This will launch the Frontity project using this theme
Publish the theme (as npm package)
1
> npm search frontity-chakra-theme
2
NAME | DESCRIPTION | AUTHOR | DATE | VERSION | KEYWORDS
3
frontity-chakra-theme | A frontity theme… | =segunadebayo | 2020-01-28 | 0.0.2 | wordpress frontity frontity-theme frontity
Copied!
1
cd packages/frontity-chakra-theme
2
npm publish
Copied!
Take into account that there cannot be two packages with the same name (property
name in your package.json) so if you try to publish a package that is already published you will get an error