Node's Play Mate

    create-nteract-app

    0.4.3 • Public • Published

    create-nteract-app

    CircleCI code style: prettier

    Create an nteractive application backed by next.js, mybinder and react with zero configuration.

    Installation

    Install create-nteract-app globally

    npm i -g create-nteract-app

    Getting Started

    Create an nteract app and run the development server.

    create-nteract-app myApp
    cd myApp
    yarn dev

    cna

    Now, navigate to http://localhost:3000/ and you should see the following:

    image

    Batteries included 🔋

    An app bootstrapped with create-nteract-app comes with:

    • @nteract components for interactive computing apps/pages
    • automatic webpack and babel configuration through next.js
    • live hot reloading
    • mdx
    • every .js or .md file in ./pages becomes a route that gets automatically processed and rendered!

    This means you can write your app in js, markdown or even both! 😄

    Your new nteract app will have the following strucure,

    .
    ├── __tests__
    │   └── index-spec.js
    ├── components
    │   ├── code-state.js
    │   └── presentation-cell.js
    ├── next.config.js
    ├── package.json
    ├── pages
    │   ├── _document.js
    │   └── index.js
    ├── scripts
    │   └── test-setup.js
    └── yarn.lock

    Commands 🤖

    1. yarn dev

      This will start the next.js server on port 3000 by default. Note, to change the port, run yarn dev -p YOUR_PORT

    2. yarn test

      This will kick off the Jest test suite. By default, we have included a snapshot test.

    3. yarn build

      This will produce an optimize set of code for production.

    4. yarn start

      This will run your optimized app on port 3000.

    5. yarn export

      This will export your code as a static HTML app.

    Contributing 🎉

    Thanks for your interest in contributing! If you get stuck at any point, don't hesitate to reach out to the nteract team on slack or through the issue tracker.

    To get started hacking on create-nteract-app, clone the repo and install dependencies.

    git clone https://github.com/nteract/create-nteract-app.git
    cd create-nteract-app
    yarn

    Now, make your changes and try them out with, yarn dev your-test-app

    This will run create-nteract-app with any modifications you have made. Test your changes with yarn test.

    See CONTRIBUTING.md for more details.

    Keywords

    none

    Install

    npm i create-nteract-app

    DownloadsWeekly Downloads

    0

    Version

    0.4.3

    License

    MIT

    Unpacked Size

    295 kB

    Total Files

    20

    Last publish

    Collaborators

    • alexandercbooth
    • rgbkrk