{"id":21658871,"url":"https://github.com/nteract/create-nteract-app","last_synced_at":"2025-07-17T21:31:53.647Z","repository":{"id":32936294,"uuid":"145657156","full_name":"nteract/create-nteract-app","owner":"nteract","description":":zap: Create an nteractive application with zero configuration","archived":true,"fork":false,"pushed_at":"2024-01-25T22:36:17.000Z","size":326,"stargazers_count":35,"open_issues_count":14,"forks_count":6,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-14T16:14:59.706Z","etag":null,"topics":["mdx","mybinder","nextjs","nteract","react"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nteract.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-08-22T04:43:54.000Z","updated_at":"2024-10-14T22:38:42.000Z","dependencies_parsed_at":"2022-09-05T16:30:22.287Z","dependency_job_id":"287ed617-6cc8-4dba-acf6-4a47da44aa34","html_url":"https://github.com/nteract/create-nteract-app","commit_stats":{"total_commits":82,"total_committers":3,"mean_commits":"27.333333333333332","dds":0.4390243902439024,"last_synced_commit":"f88e83b63cd4997fa4b16d724e7f08ee185db6d8"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fcreate-nteract-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fcreate-nteract-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fcreate-nteract-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fcreate-nteract-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nteract","download_url":"https://codeload.github.com/nteract/create-nteract-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226305044,"owners_count":17603731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mdx","mybinder","nextjs","nteract","react"],"created_at":"2024-11-25T09:29:58.538Z","updated_at":"2024-11-25T09:30:17.246Z","avatar_url":"https://github.com/nteract.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# create-nteract-app\n\n[![CircleCI](https://circleci.com/gh/nteract/create-nteract-app/tree/master.svg?style=svg)](https://circleci.com/gh/nteract/create-nteract-app/tree/master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\n⚠️ This project is now archived due to new directions for the open source project, particularly to reduce our maintenance burden. ⚠️\n\n\u003e ~~Create an nteractive application backed by next.js, mybinder and react with zero configuration.~~\n\n## Installation\n\nInstall `create-nteract-app` globally\n\n```bash\nnpm i -g create-nteract-app\n```\n\n## Getting Started\n\nCreate an nteract app and run the development server.\n\n```bash\ncreate-nteract-app myApp\ncd myApp\nyarn dev\n```\n\n![cna](https://user-images.githubusercontent.com/15242567/45272888-dd35c380-b47d-11e8-9590-b556baf04783.gif)\n\nNow, navigate to [http://localhost:3000/](http://localhost:3000/) and you should see the following:\n\n![image](https://user-images.githubusercontent.com/15242567/45272197-d1e09900-b479-11e8-8788-062b8659182b.png)\n\n## Batteries included :battery:\n\nAn app bootstrapped with `create-nteract-app` comes with:\n\n- [@nteract](https://github.com/nteract) components for interactive computing apps/pages\n- automatic webpack and babel configuration through [next.js](https://nextjs.org/)\n- live hot reloading\n- [mdx](https://mdxjs.com/)\n- every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered!\n\nThis means you can write your app in `js`, `markdown` or even both! :smile:\n\nYour new nteract app will have the following strucure,\n\n```bash\n.\n├── __tests__\n│   └── index-spec.js\n├── components\n│   ├── code-state.js\n│   └── presentation-cell.js\n├── next.config.js\n├── package.json\n├── pages\n│   ├── _document.js\n│   └── index.js\n├── scripts\n│   └── test-setup.js\n└── yarn.lock\n```\n\n## Commands :robot:\n\n1. `yarn dev`\n\n   This will start the next.js server on port `3000` by default. Note, to change the port, run `yarn dev -p YOUR_PORT`\n\n2. `yarn test`\n\n   This will kick off the [Jest](https://jestjs.io/) test suite. By default, we have included a snapshot test.\n\n3. `yarn build`\n\n   This will produce an optimize set of code for production.\n\n4. `yarn start`\n\n   This will run your optimized app on port 3000.\n\n5. `yarn export`\n\n   This will export your code as a static HTML app.\n\n## Contributing :tada:\n\nThanks 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.\n\nTo get started hacking on `create-nteract-app`, clone the repo and install dependencies.\n\n```bash\ngit clone https://github.com/nteract/create-nteract-app.git\ncd create-nteract-app\nyarn\n```\n\nNow, make your changes and try them out with,\n`yarn dev your-test-app`\n\nThis will run `create-nteract-app` with any modifications you have made. Test your changes with `yarn test`.\n\nSee [CONTRIBUTING.md](https://github.com/nteract/create-nteract-app/blob/master/CONTRIBUTING.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnteract%2Fcreate-nteract-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnteract%2Fcreate-nteract-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnteract%2Fcreate-nteract-app/lists"}