FRAME

Create a React / Preact / Next.js Project

Install

$ npm install -g frame-cli

Usage

You can create a new project by running FRAME without arguments. An UI will spawn and you can select your project type and give it a name. You can also skip the UI by defining a type and a name as arguments.

Usage:

 $ frame <project-type | project-name> [options]

Supported Project Types:

 react, preact, next

Options:

 --skip-git       don't initialize a git repository
 --skip-install   don't install the project dependencies

Examples:

– Spawn the UI

 $ frame

– Create a new React Project

 $ frame react my-awesome-new-project

– Create a new Preact Project and skip git

 $ frame preact my-awesome-preact-project --skip-git

– Create a new React Project and skip npm install

 $ frame react my-awesome-preact-project --skip-install

Development

Run $ npm run dev and start developing. In addition to that, running the test watch mode is recommendable: $ npm run test:watch

You can now test your new features with:

$ node ./build/bin/frame.js

All Commands

Full Test

This runs the full test, including several npm installs. It will also lint your code with xo.

$ npm test

Building

$ npm run build will just build the /src folder. Running $ npm test will lint and build everything.

Heavily inspired by nwb