|
1 | 1 | # create-nteract-app
|
2 | 2 |
|
3 |
| -[](https://circleci.com/gh/nteract/create-nteract-app/tree/master) |
| 3 | +[](https://circleci.com/gh/nteract/create-nteract-app/tree/master) [](https://github.com/prettier/prettier) |
4 | 4 |
|
5 | 5 | > Create an nteractive application backed by next.js, mybinder and react with zero configuration.
|
6 | 6 |
|
@@ -33,12 +33,12 @@ Now, navigate to [http://localhost:3000/](http://localhost:3000/) and you should
|
33 | 33 | An app bootstrapped with `create-nteract-app` comes with:
|
34 | 34 |
|
35 | 35 | - [@nteract](https://github.com/nteract) components for interactive computing apps/pages
|
36 |
| -- automatic webpack and babel configuration through next.js |
| 36 | +- automatic webpack and babel configuration through [next.js](https://nextjs.org/) |
37 | 37 | - live hot reloading
|
38 |
| -- mdx |
39 |
| -- Every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered! |
| 38 | +- [mdx](https://mdxjs.com/) |
| 39 | +- every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered! |
40 | 40 |
|
41 |
| -This means you can write your app in `js` or `markdown` or even both! :smile: |
| 41 | +This means you can write your app in `js`, `markdown` or even both! :smile: |
42 | 42 |
|
43 | 43 | Your new nteract app will have the following strucure,
|
44 | 44 |
|
@@ -80,3 +80,22 @@ Your new nteract app will have the following strucure,
|
80 | 80 | 5. `yarn export`
|
81 | 81 |
|
82 | 82 | This will export your code as a static HTML app.
|
| 83 | + |
| 84 | +## Contributing :tada: |
| 85 | + |
| 86 | +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. |
| 87 | + |
| 88 | +To get started hacking on `create-nteract-app`, clone the repo and install dependencies. |
| 89 | + |
| 90 | +```bash |
| 91 | +git clone https://github.com/nteract/create-nteract-app.git |
| 92 | +cd create-nteract-app |
| 93 | +yarn |
| 94 | +``` |
| 95 | + |
| 96 | +Now, make your changes and try them out with, |
| 97 | +`yarn dev your-test-app` |
| 98 | + |
| 99 | +This will run `create-nteract-app` with any modifications you have made. Test your changes with `yarn test`. |
| 100 | + |
| 101 | +See [CONTRIBUTING.md](https://github.com/nteract/create-nteract-app/blob/master/CONTRIBUTING.md) for more details. |
0 commit comments