https://github.com/choojs/create-choo-app
🚞 - create a fresh choo application
https://github.com/choojs/create-choo-app
Last synced: 12 months ago
JSON representation
🚞 - create a fresh choo application
- Host: GitHub
- URL: https://github.com/choojs/create-choo-app
- Owner: choojs
- License: mit
- Created: 2017-07-21T17:37:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-21T19:42:03.000Z (about 4 years ago)
- Last Synced: 2025-06-04T00:05:42.785Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.32 MB
- Stars: 180
- Watchers: 9
- Forks: 30
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-choo-app [![stability][0]][1]
[![npm version][2]][3] [![build status][4]][5]
[![downloads][8]][9] [![js-standard-style][10]][11]
Create a fresh choo application. Because starting a new project should take
minutes, not days.
## Usage
```sh
$ npx create-choo-app
```
## ⚠️ 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".
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](https://github.com/choojs/choo) | Production | Fast, 4kb framework.
[choo-service-worker](https://github.com/choojs/choo-service-worker) | Production | Offline support for Choo.
[sheetify](https://github.com/stackcss/sheetify/) | Production | Hyper performant CSS-in-JS.
[tachyons](http://tachyons.io/) | Production | A minimalist CSS toolkit.
[bankai](https://github.com/choojs/bankai) | Development | An asset bundler and static file server.
[choo-devtools](https://github.com/choojs/choo-devtools) | Development | Debug Choo applications.
[choo-scaffold](https://github.com/choojs/choo-scaffold) | Development | Generate new application files.
[dependency-check](https://github.com/maxogden/dependency-check) | Development | Verify project dependencies.
[standard](https://standardjs.com/) | 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
```txt
$ create-choo-app [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](https://github.com/perguth/create-choo-app).
## License
[MIT](https://tldrlegal.com/license/mit-license)
[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/create-choo-app.svg?style=flat-square
[3]: https://npmjs.org/package/create-choo-app
[4]: https://img.shields.io/travis/choojs/create-choo-app/master.svg?style=flat-square
[5]: https://travis-ci.org/choojs/create-choo-app
[6]: https://img.shields.io/codecov/c/github/choojs/create-choo-app/master.svg?style=flat-square
[7]: https://codecov.io/github/choojs/create-choo-app
[8]: http://img.shields.io/npm/dm/create-choo-app.svg?style=flat-square
[9]: https://npmjs.org/package/create-choo-app
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard