• Stars
    star
    181
  • Rank 212,110 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🚞 - create a fresh choo application

create-choo-app stability

npm version build status downloads js-standard-style

Create a fresh choo application. Because starting a new project should take minutes, not days.

Usage

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

⚠️ 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". firefox01

Step 2

More details emerge! Click on "Add Exception". firefox02

Step 3

In the dropdown click "Confirm Security Exception". firefox03

Step 4

Success! firefox04
Chrome Instructions Click the "more details" dropdown, then click "proceed". chrome01
Safari Instructions

Step 1

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

Step 2

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

Step 3

The box is checked! Click "Continue". safari03

Step 4

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

Step 5

Success! safari04

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.

Removing Dependencies

If you want to remove Tachyons you can do so by running npm uninstall tachyons and removing the reference to Tachyons in ./index.js.

API

  $ create-choo-app <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-app

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

  Do you enjoy using this software? Become a backer:
  https://opencollective.com/choo

See the generated output here.

License

MIT

More Repositories

1

choo

πŸš‚πŸš‹ - sturdy 4kb frontend framework
JavaScript
6,776
star
2

bankai

πŸš‰ - friendly web compiler
JavaScript
1,088
star
3

hyperx

🏷 - tagged template string virtual dom builder
JavaScript
1,010
star
4

nanomorph

πŸš… - Hyper fast diffing algorithm for real DOM nodes
JavaScript
726
star
5

nanohtml

πŸ‰ HTML template strings for the Browser with support for Server Side Rendering in Node.
JavaScript
687
star
6

nanographql

Tiny graphQL client library
JavaScript
421
star
7

nanocomponent

πŸšƒ - create performant HTML components
JavaScript
366
star
8

wayfarer

πŸ‘“ composable trie based router
JavaScript
332
star
9

choo-handbook

πŸš‚βœ‹πŸ“– - Learn the choo framework through a set of exercises
HTML
268
star
10

nanobus

🚎 - Tiny message bus
JavaScript
225
star
11

awesome-choo

πŸŒ… Awesome things related with choo framework
197
star
12

nanostate

🚦- Small Finite State Machines
JavaScript
170
star
13

nanorouter

πŸ›€ - Small frontend router
JavaScript
116
star
14

nanocomponent-adapters

πŸ”Œ - Convert a nanocomponent to a component for your favourite API or library (web components, (p)react, angular)
JavaScript
96
star
15

choop

πŸš‚βš›οΈ - choo architecture for preact
JavaScript
93
star
16

on-idle

😴 - Detect when the browser is idle
JavaScript
82
star
17

nanologger

πŸ“œ - Cute browser logs
JavaScript
80
star
18

nanoanimation

πŸ‘¨β€πŸŽ¨ - Safety wrapper around the Web Animation API
JavaScript
72
star
19

nanoraf

🎞 - Only call RAF when needed
JavaScript
71
star
20

choo-devtools

πŸ’Ό - Expose a choo instance on the window
JavaScript
53
star
21

nanoquery

πŸ“‡ - Tiny querystring module
JavaScript
49
star
22

nanotask

Microtask queue scheduler for the browser
JavaScript
47
star
23

choo-log

πŸ“ƒ - Development logger for choo
JavaScript
47
star
24

nanoscheduler

Schedule work to be completed when the user agent is idle.
JavaScript
46
star
25

website

πŸš‡ - Hyper Train Transfer Protocol (HTTP)
JavaScript
46
star
26

nanohref

β›“ - Tiny href click handler library
JavaScript
41
star
27

nanotick

process.nextTick() batching utility
JavaScript
37
star
28

choo-store

Lightweight state structure for choo apps.
JavaScript
37
star
29

nanotiming

⏲ - Small timing library
JavaScript
35
star
30

create-choo-electron

:electron: - Create a fresh Choo Electron application
JavaScript
29
star
31

object-change-callsite

Determine the callsite of an object change using Proxies
JavaScript
27
star
32

choo-reload

⛽️ - Livereloading package for choo
JavaScript
27
star
33

on-performance

Listen for performance timeline events
JavaScript
26
star
34

nanobeacon

Small navigator.sendBeacon wrapper
JavaScript
25
star
35

choo-service-worker

πŸ‘· - Service worker loader for choo
JavaScript
24
star
36

choo-scaffold

πŸ— - Scaffold out files for a Choo project
JavaScript
24
star
37

choo-notification

Web Notification plugin for Choo
JavaScript
22
star
38

nanobounce

Smol debounce package
JavaScript
19
star
39

choo-choo

πŸŽ“ learn choo from the command line!
JavaScript
19
star
40

nanomount

Mount a DOM tree on a target node
JavaScript
19
star
41

choo-redirect

🎬 - Redirect a view to another view
JavaScript
19
star
42

persist-storage

πŸ—„ - Enable persistent storage in the browser
JavaScript
19
star
43

nanohistory

Small browser history library
JavaScript
14
star
44

choo-hooks

🎣 - Hook into Choo's events and timings
JavaScript
12
star
45

nanolocation

πŸ“- Small window.location library
JavaScript
10
star
46

discuss

🎭 – Discuss project organization, initiatives, and anything else!
8
star
47

nanocache

Cache Nanocomponents.
JavaScript
7
star
48

bankai-website

JavaScript
6
star
49

choo-umd

πŸ™ˆ - umd build for choo framework
HTML
3
star