create

Creates a new Frontity project.

npx frontity create [project-name] [options]

Arguments

[project-name]

The name of your Frontity project. It will also be the name of the folder that this command will create for you with the files of your Frontity project inside

[options]

Option

Description

-h <theme>, --theme <theme>

The theme to use

-t, --typescript

Adds support for TypeScript

-c, --use-cwd

Generates the project in the current directory

-n, --no-prompt

Skips prompting the user for options

-h, --help

Output usage information

The --theme option

You can pick one of Frontity's "official" two themes (--theme mars-theme or --theme twentytwenty-theme). But you can also use any custom theme as long as it's published on npm. Just pass the theme name on the command-line like --theme ThemesPackageNameInNPM

Examples

  • Create a Frontity project named my-awesome-project

npx frontity create my-awesome-project
npx frontity create --theme frontity-chakra-theme cool-project
  • If you leave out both of the arguments, the CLI will run an interactive shell asking for these inputs:

> npx frontity create
...
? Enter a name for the project: awesome project
? Pick a starter theme to clone: @frontity/mars-theme (recommended)
โœ” Creating README.md.
โœ” Creating package.json.
โœ” Creating frontity.settings.js.
โœ” Cloning @frontity/mars-theme.
โœ” Installing dependencies.
โœ” Downloading favicon.ico.
โ€‹
Frontity project created.
โ€‹
? Do you want to receive framework updates by email? No
โ€‹
Ok, that's fine! ๐Ÿ˜‰
You can subscribe at any point with npx frontity subscribe <email>.
โ€‹
Run cd awesome project && npx frontity dev and have fun! ๐ŸŽ‰
โ€‹
You can find docs at https://docs.frontity.org/.
For technical support and assistance please join our community at https://community.frontity.org/.