Skip to content
This repository was archived by the owner on Jan 25, 2024. It is now read-only.

Commit 46ab877

Browse files
start improving readme
1 parent 4fa18cf commit 46ab877

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[![CircleCI](https://circleci.com/gh/nteract/create-nteract-app/tree/master.svg?style=svg)](https://circleci.com/gh/nteract/create-nteract-app/tree/master)
44

5+
> Create an nteractive application backed by next.js, mybinder and react with zero configuration.
6+
57
## Installation
68

79
Install `create-nteract-app` globally
@@ -10,16 +12,48 @@ Install `create-nteract-app` globally
1012
npm i -g create-nteract-app
1113
```
1214

13-
## Usage
15+
## Getting Started
1416

1517
Create an nteract app and run the development server.
1618

1719
```bash
18-
create-nteract-app yourApp
19-
cd yourApp
20+
create-nteract-app myApp
21+
cd myApp
2022
yarn dev
2123
```
2224

23-
Now, navigate to [here](http://localhost:3000/) and you should see the following:
25+
![cna](https://user-images.githubusercontent.com/15242567/45272888-dd35c380-b47d-11e8-9590-b556baf04783.gif)
26+
27+
Now, navigate to [http://localhost:3000/](http://localhost:3000/) and you should see the following:
28+
29+
![image](https://user-images.githubusercontent.com/15242567/45272197-d1e09900-b479-11e8-8788-062b8659182b.png)
30+
31+
## Batteries included
32+
33+
An app bootstrapped with `create-nteract-app` comes with:
2434

25-
![](Screenshot.png)
35+
- @nteract components for interactive computing apps/pages
36+
- webpack and babel configuration through next.js
37+
- server rendering of `./pages`
38+
- live hot reloading
39+
- mdx
40+
This means you can write your app in `js` or `markdown` or even both! :smile:
41+
42+
Your new nteract app will have the following strucure,
43+
44+
```bash
45+
.
46+
├── __tests__
47+
│ └── index-spec.js
48+
├── components
49+
│ ├── code-state.js
50+
│ └── presentation-cell.js
51+
├── next.config.js
52+
├── package.json
53+
├── pages
54+
│ ├── _document.js
55+
│ └── index.js
56+
├── scripts
57+
│ └── test-setup.js
58+
└── yarn.lock
59+
```

0 commit comments

Comments
 (0)