Home

Awesome

Create Hyperapp

Create Hyperapps with no build configuration.

Create Hyperapp works on macOS, Windows, and Linux with Node.js >= 8.

Quick Overview

npx create-hyperapp my-app
cd my-app
npm start

Then open http://localhost:3000 to see your app. When you’re ready to deploy to production, create a minified bundle with npm run build.

Creating an App

To create a new app, you may choose one of the following methods:

npx

npx create-hyperapp my-app

(npx comes with npm 5.2+ and higher.)

npm

npm init hyperapp my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create hyperapp my-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure and install dependencies:

my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── public
│   ├── favicon.png
│   ├── index.html
└── src
    ├── App.css
    ├── App.js
    ├── App.test.js
    ├── index.css
    ├── index.js
    ├── logo.svg

No configuration or complicated folder structures, just the files you need to build your app. Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode.

Open http://localhost:3000 to view it in the browser.

The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.

npm test or yarn test

Runs the test watcher in an interactive mode. By default only tests related to files changed since the last commit are run.

Read more about testing.

npm run build or yarn build

Builds the app for production to the build folder. It bundles in production mode and optimizes the build for the best performance. The build is minified and the filenames include unique hashes based on the contents. Your app is ready to be deployed.

License

Create Hyperapp is MIT licensed. See LICENSE.