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

Commit eb829e5

Browse files
adding commands
1 parent 46ab877 commit eb829e5

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,17 @@ Now, navigate to [http://localhost:3000/](http://localhost:3000/) and you should
2828

2929
![image](https://user-images.githubusercontent.com/15242567/45272197-d1e09900-b479-11e8-8788-062b8659182b.png)
3030

31-
## Batteries included
31+
## Batteries included :battery:
3232

3333
An app bootstrapped with `create-nteract-app` comes with:
3434

35-
- @nteract components for interactive computing apps/pages
36-
- webpack and babel configuration through next.js
37-
- server rendering of `./pages`
35+
- [@nteract](https://github.com/nteract) components for interactive computing apps/pages
36+
- automatic webpack and babel configuration through next.js
3837
- live hot reloading
3938
- mdx
40-
This means you can write your app in `js` or `markdown` or even both! :smile:
39+
- Every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered!
40+
41+
This means you can write your app in `js` or `markdown` or even both! :smile:
4142

4243
Your new nteract app will have the following strucure,
4344

@@ -57,3 +58,25 @@ Your new nteract app will have the following strucure,
5758
│ └── test-setup.js
5859
└── yarn.lock
5960
```
61+
62+
## Commands :robot:
63+
64+
1. `yarn dev`
65+
66+
This will start the next.js server on port `3000` by default. Note, to change the port, run `yarn dev -p YOUR_PORT`
67+
68+
2. `yarn test`
69+
70+
This will kick off the [Jest](https://jestjs.io/) test suite. By default, we have included a snapshot test.
71+
72+
3. `yarn build`
73+
74+
This will produce an optimize set of code for production.
75+
76+
4. `yarn start`
77+
78+
This will run your optimized app on port 3000.
79+
80+
5. `yarn export`
81+
82+
This will export your code as a static HTML app.

0 commit comments

Comments
 (0)