create-choo-app for zeit

Create a fresh choo application for use with zeit. It installs choo, along with:

• bankai, an asset bundler and static file server
• sheetify, a CSS bundler
• choo-log and choo-devtools, to improve the development experience
• choo-service-worker, for offline support
• tachyons, a minimalist CSS toolkit
• standard, a JavaScript linter
• serve, a zeit file server
• dependency-check, to verify your dependencies are listed in package.json

Usage

Example of how to install a test choo.js app locally.

$ npx create-choo-zeit <project-directory>

Example of how to install the test locally and then deploy the test app to zeit. It should all just work.

$ npx create-choo-zeit <project-directory> && cd <project-directory>  && npm run deploy

⚠️ HTTPS Instructions

When you first open up your application in a browser, you'll probably see a warning page about HTTPS connections being untrusted. No worries, this is entirely expected behavior. Follow the instructions below to solve this for your browser.

How does this work?

For HTTPS to run on localhost, we must sign a TLS certificate locally. This is better known as a "self-signed certificate". Browsers actively check for certificates from unknown providers, and warn you (for good reason!) In our case, however, it's safe to ignore.

HTTPS is needed for an increasing amount of APIs to work in the browser. For example if you want to test HTTP/2 connections or use parts of the storage API, you have no choice but to use an HTTPS connection on localhost. That's why we try and make this work as efficiently, and securely as possible.

We generate a unique certificate for each Bankai installation at ~/.config/bankai. This means that you'll only need to trust an HTTPS certificate for Bankai once. This should be secure from remote attackers, because unless they have successfully acquired access to your machine's filesystem, they won't be able to replicate the certificate.

Firefox Instructions

Step 1

A wild security screen appears!. Click on "advanced".

Step 2

More details emerge! Click on "Add Exception".

Step 3

In the dropdown click "Confirm Security Exception".

Step 4

Success!

Chrome Instructions

Click the "more details" dropdown, then click "proceed". Pull Request for screenshots welcome!

Safari Instructions

Step 1

A wild security screen appears! Click "Show Certificate".

Step 2

More details emerge! Check "Always trust 'localhost'…".

Step 3

The box is checked! Click "Continue".

Step 4

A box is asking you for your crendentials. Fill them in, and hit "Enter".

Step 5

Success!

Dependencies

create-choo-app installs the following dependencies:

Name	Dependency Type	Description
choo	Production	Fast, 4kb framework.
choo-service-worker	Production	Offline support for Choo.
sheetify	Production	Hyper performant CSS-in-JS.
tachyons	Production	A minimalist CSS toolkit.
bankai	Development	An asset bundler and static file server.
choo-devtools	Development	Debug Choo applications.
choo-scaffold	Development	Generate new application files.
dependency-check	Development	Verify project dependencies.
standard	Development	Statically check JavaScript files for errors.

API

  $ create-choo-zeit <project-directory> [options]

  Options:

    -h, --help        print usage
    -v, --version     print version
    -q, --quiet       don't output any logs

  Examples:

    Create a new Choo application
    $ create-choo-zeit

  Running into trouble? Feel free to file an issue:
  https://github.com/shotlom/create-choo-zeit/issues/new

License

MIT