https://github.com/tomoat/create-next-app
Create Next.js apps in one command
https://github.com/tomoat/create-next-app
Last synced: about 1 year ago
JSON representation
Create Next.js apps in one command
- Host: GitHub
- URL: https://github.com/tomoat/create-next-app
- Owner: tomoat
- License: mit
- Created: 2017-04-30T09:39:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-29T14:34:58.000Z (about 9 years ago)
- Last Synced: 2025-03-24T09:38:25.873Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://open.segment.com/create-next-app
- Size: 28.3 KB
- Stars: 3
- Watchers: 1
- Forks: 138
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create Next App
The easiest way to create a [React](https://facebook.github.io/react) app with server-side rendering thanks to [Next.js](https://github.com/zeit/next.js)
- [Getting Started](#getting-started) — How to create an app
- [User Guide](https://github.com/segmentio/create-next-app/blob/master/lib/templates/default/README.md) — How to develop apps started with Create Next App
- [Starting from Examples](#starting-from-examples) — How to create an app from a Next.js example
If you run into any issues or have feedback, please [file an issue](https://github.com/segmentio/create-next-app/issues/new)
## Overview
```sh
npm install -g create-next-app
create-next-app my-app
cd my-app/
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) to view your running app.
When you're ready for production, run `npm run build` then `npm run start`.
### Start Coding Now
You **don't** need to install or setup Webpack or Babel.
They come packaged with `next`, so you can just start coding.
After running `create-next-app`, you're good to go!
## Getting Started
### Installation
Install it once globally:
```sh
npm install -g create-next-app
```
**You’ll need to have Node >= 4 on your machine**.
**We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage.** You can use [nvm](https://github.com/creationix/nvm#usage) to easily switch Node versions between different projects.
**You don't need to use Node as your primary backend**. The Node installation is only required for Create Next App and running the Next.js server in development/production.
### Creating an App
To create a new app, run:
```
create-next-app my-app
cd my-app
```
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install necessary dependencies:
```
my-app/
README.md
package.json
next.config.js
components/
index.js
head.js
nav.js
pages/
index.js
static/
favicon.ico
```
Routing in Next.js is based on the file system, so `./pages/index.js` maps to the `/` route and
`./pages/about.js` would map to `/about`.
The `./static` directory maps to `/static` in the `next` server, so you can put all your
other static resources like images or compiled CSS in there.
Out of the box, we get:
- Automatic transpilation and bundling (with webpack and babel)
- Hot code reloading
- Server rendering and indexing of `./pages`
- Static file serving. `./static/` is mapped to `/static/`
Once the installation is finished, you can run some commands in your project:
### `npm run dev` or `yarn dev`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
### `npm run build` or `yarn build`
Builds the app for production to the `.next` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
### `npm run start` or `yarn start`
Starts the application in production mode.
The application should be compiled with \`npm run build\` first.
Now you're ready to code & deploy your app!
## Starting from Examples
There are a ton of examples in the [Next.js repo](https://github.com/zeit/next.js/tree/master/examples/) (and growing!) that you can use to bootstrap your app.
To use an example:
1. Go to https://open.segment.com/create-next-app#examples
2. Search for an example you want and get it's name (looks like `basic-css`)
3. Run: `create-next-app --example basic-css example-app`
4. Done 💥
## Acknowledgements
We are grateful to the authors of existing related projects for their ideas as inspiration:
* [Create React App](https://github.com/facebookincubator/create-react-app)
* [Next.js](https://github.com/zeit/next.js)
* [@eanplatter](https://github.com/eanplatter)
* [@insin](https://github.com/insin)
* [@mxstbr](https://github.com/mxstbr)
Looking for alternatives? Here are some other project starter kits:
* [Create React App](https://github.com/facebookincubator/create-react-app)
* [insin/nwb](https://github.com/insin/nwb)
* [mozilla-neutrino/neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev)
* [NYTimes/kyt](https://github.com/NYTimes/kyt)
* [gatsbyjs/gatsby](https://github.com/gatsbyjs/gatsby)
* [enclave](https://github.com/eanplatter/enclave)
* [motion](https://github.com/motion/motion)
* [quik](https://github.com/satya164/quik)
* [sagui](https://github.com/saguijs/sagui)
* [roc](https://github.com/rocjs/roc)
* [aik](https://github.com/d4rkr00t/aik)
* [react-app](https://github.com/kriasoft/react-app)
* [dev-toolkit](https://github.com/stoikerty/dev-toolkit)
* [tarec](https://github.com/geowarin/tarec)
* [sku](https://github.com/seek-oss/sku)
Questions? Feedback? [Please let us know](https://github.com/segmentio/create-next-app/issues/new)
## License (MIT)
```
WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|
```
Copyright (c) 2017-present Segment.io, Inc. friends@segment.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.