Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More helpful README #14830

Merged
merged 9 commits into from Jul 24, 2020
Merged

More helpful README #14830

merged 9 commits into from Jul 24, 2020

Conversation

MehediH
Copy link
Contributor

@MehediH MehediH commented Jul 3, 2020

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site. Should be more SEO friendly, and helpful to newcomers.

fixes #14708.

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.
@ijjk
Copy link
Member

ijjk commented Jul 3, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 13.9s 13.6s -307ms
nodeModulesSize 66.1 MB 66.1 MB ⚠️ +2.52 kB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.284 2.559 ⚠️ +0.28
/ avg req/sec 1094.46 976.94 ⚠️ -117.52
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.533 1.522 -0.01
/error-in-render avg req/sec 1630.5 1642.75 +12.25
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
main-HASH.js gzip 6.63 kB 6.63 kB
webpack-HASH.js gzip 751 B 751 B
19b7e98f51cc..18e4.js gzip 10.7 kB 10.7 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 57.2 kB 57.2 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
main-HASH.module.js gzip 5.71 kB 5.71 kB
webpack-HASH..dule.js gzip 751 B 751 B
19b7e98f51cc..dule.js gzip 7.09 kB 7.09 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary MehediH/next.js canary Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB
Overall change 26.3 kB 26.3 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 268 B 268 B
_buildManife..dule.js gzip 272 B 272 B
Overall change 540 B 540 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 954 B 954 B
link.html gzip 959 B 959 B
withRouter.html gzip 946 B 946 B
Overall change 2.86 kB 2.86 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 15.5s 15.5s -57ms
nodeModulesSize 66.1 MB 66.1 MB ⚠️ +2.52 kB
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
main-HASH.js gzip 6.63 kB 6.63 kB
webpack-HASH.js gzip 751 B 751 B
19b7e98f51cc..18e4.js gzip 10.7 kB 10.7 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 57.2 kB 57.2 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
main-HASH.module.js gzip 5.71 kB 5.71 kB
webpack-HASH..dule.js gzip 751 B 751 B
19b7e98f51cc..dule.js gzip 7.09 kB 7.09 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary MehediH/next.js canary Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB
Overall change 26.3 kB 26.3 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 268 B 268 B
_buildManife..dule.js gzip 272 B 272 B
Overall change 540 B 540 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 876 kB 876 kB
404.html 4.17 kB 4.17 kB
hooks.html 3.79 kB 3.79 kB
index.js 876 kB 876 kB
link.js 915 kB 915 kB
routerDirect.js 908 kB 908 kB
withRouter.js 908 kB 908 kB
Overall change 4.49 MB 4.49 MB
Commit: a784011

Copy link
Member

@lfades lfades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current PR is not making the changes requested in #14708.

The changes have to go into adding a new page in our docs for create-next-app, and updating the readme of create-next-app (in packages/create-next-app)

The Next.js readme is simple and links to our most important resources in the Next.js site, searching for Next.js also gives back expected results (and out website first), changes here are welcome but not the current priority.

packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
Copy link
Member

@lfades lfades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested some changes.

Note: I'm reviewing it as an update to the current Next.js readme, but create-next-app still requires documentation and a readme update.

@MehediH
Copy link
Contributor Author

MehediH commented Jul 3, 2020

@lfades Hey, thank you for taking the time to review this! I misunderstood the original issue and thought the improvements were required for the main Next.js README. Shall I go ahead and take out some parts from the edits I made to the README and create the new docs page for create-next-app?

@lfades
Copy link
Member

lfades commented Jul 5, 2020

@MehediH Yes feel free to do that 👍

@MehediH
Copy link
Contributor Author

MehediH commented Jul 5, 2020

@lfades Will do! So for the new docs page for create-next-app, should it go under the root of /docs as a dedicated page, or should I add it to the existing Getting Started docs page?

Update: I just pushed a commit with a new readme for create-next-app. Please let me know if this looks good, I will then go ahead and use this to make the new docs for create-next-app as well.

An updated readme with more details on options, benefits, etc.
@ijjk ijjk added the create-next-app Related to our CLI tool for quickly starting a new Next.js application. label Jul 5, 2020
@ijjk
Copy link
Member

ijjk commented Jul 5, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 12s 12.1s ⚠️ +104ms
nodeModulesSize 66.1 MB 66.1 MB ⚠️ +2.52 kB
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.077 2.063 -0.01
/ avg req/sec 1203.52 1211.55 +8.03
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.449 1.392 -0.06
/error-in-render avg req/sec 1724.98 1795.96 +70.98
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
main-HASH.js gzip 6.63 kB 6.63 kB
webpack-HASH.js gzip 751 B 751 B
19b7e98f51cc..18e4.js gzip 10.7 kB 10.7 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 57.2 kB 57.2 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
main-HASH.module.js gzip 5.71 kB 5.71 kB
webpack-HASH..dule.js gzip 751 B 751 B
19b7e98f51cc..dule.js gzip 7.09 kB 7.09 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary MehediH/next.js canary Change
polyfills-HASH.js gzip 26.4 kB 26.4 kB
Overall change 26.4 kB 26.4 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 268 B 268 B
_buildManife..dule.js gzip 272 B 272 B
Overall change 540 B 540 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 954 B 954 B
link.html gzip 958 B 958 B
withRouter.html gzip 945 B 945 B
Overall change 2.86 kB 2.86 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 13s 12.6s -354ms
nodeModulesSize 66.1 MB 66.1 MB ⚠️ +2.52 kB
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
main-HASH.js gzip 6.63 kB 6.63 kB
webpack-HASH.js gzip 751 B 751 B
19b7e98f51cc..18e4.js gzip 10.7 kB 10.7 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 57.2 kB 57.2 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
main-HASH.module.js gzip 5.71 kB 5.71 kB
webpack-HASH..dule.js gzip 751 B 751 B
19b7e98f51cc..dule.js gzip 7.09 kB 7.09 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 52.7 kB 52.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary MehediH/next.js canary Change
polyfills-HASH.js gzip 26.4 kB 26.4 kB
Overall change 26.4 kB 26.4 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 268 B 268 B
_buildManife..dule.js gzip 272 B 272 B
Overall change 540 B 540 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 876 kB 876 kB
404.html 4.17 kB 4.17 kB
hooks.html 3.79 kB 3.79 kB
index.js 876 kB 876 kB
link.js 915 kB 915 kB
routerDirect.js 908 kB 908 kB
withRouter.js 908 kB 908 kB
Overall change 4.49 MB 4.49 MB
Commit: f1b1b17

@MehediH
Copy link
Contributor Author

MehediH commented Jul 21, 2020

@lfades Hey, sorry but were you able to take a look at the changes I made?

Copy link
Member

@lfades lfades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MehediH Thank you so much for the hard work, can you please address my suggestions 🙏

Co-authored-by: Luis Alvarez D. <luis@vercel.com>
@MehediH
Copy link
Contributor Author

MehediH commented Jul 22, 2020

@lfades Thank you for all the edits and reviewing this! I have merged all the suggestions together and fixed the redundant bits at the beginning.

Please let me know if anything else needs to be changed. Also, would it be better for me to start a different PR for the docs page of create-next-app?

@ijjk
Copy link
Member

ijjk commented Jul 22, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 14s 14.2s ⚠️ +152ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.332 2.324 -0.01
/ avg req/sec 1072.22 1075.63 +3.41
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.593 1.53 -0.06
/error-in-render avg req/sec 1569.42 1633.82 +64.4
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..28cd.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.5 kB 87.5 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 947 B 947 B
link.html gzip 952 B 952 B
withRouter.html gzip 939 B 939 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 15s 15.2s ⚠️ +194ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..28cd.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.5 kB 87.5 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 881 kB 881 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 881 kB 881 kB
link.js 922 kB 922 kB
routerDirect.js 916 kB 916 kB
withRouter.js 916 kB 916 kB
Overall change 4.52 MB 4.52 MB
Commit: 07a3add

@ijjk
Copy link
Member

ijjk commented Jul 22, 2020

Stats from current PR

Default Server Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 12.1s 12.2s ⚠️ +95ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 1.934 1.929 0
/ avg req/sec 1292.39 1296.16 +3.77
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.144 1.144
/error-in-render avg req/sec 2184.46 2185.5 +1.04
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..28cd.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.5 kB 87.5 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 947 B 947 B
link.html gzip 952 B 952 B
withRouter.html gzip 939 B 939 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 13.1s 13.2s ⚠️ +162ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..28cd.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.5 kB 87.5 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 881 kB 881 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 881 kB 881 kB
link.js 922 kB 922 kB
routerDirect.js 916 kB 916 kB
withRouter.js 916 kB 916 kB
Overall change 4.52 MB 4.52 MB
Commit: 47e09f6

@lfades
Copy link
Member

lfades commented Jul 23, 2020

@MehediH Thank you for reviewing my suggestions, the readme for create-next-app looks good to me now, but please review my first suggestions, the ones about the main readme.

To add create-next-app to our docs, please start a new PR 👍

@ijjk
Copy link
Member

ijjk commented Jul 23, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 14.3s 14.1s -191ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.341 2.279 -0.06
/ avg req/sec 1067.87 1096.85 +28.98
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.51 1.502 -0.01
/error-in-render avg req/sec 1656.03 1664.14 +8.11
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 946 B 946 B
link.html gzip 952 B 952 B
withRouter.html gzip 938 B 938 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 15.2s 15.5s ⚠️ +274ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +2.52 kB
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 881 kB 881 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 881 kB 881 kB
link.js 922 kB 922 kB
routerDirect.js 916 kB 916 kB
withRouter.js 916 kB 916 kB
Overall change 4.52 MB 4.52 MB
Commit: 8468e0f

* **Pre-Rendering** - Statically generated and server-rendered React applications have never been easier.
* **Static Exporting** - No need to learn a new framework. Exporting a static site with Next.js is as easy as a single command.
* **CSS-in-JS** - Next.js comes with `styled-jsx` included, but it also works with every CSS-in-JS solution you know and love.
* **Built-in TypeScript support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Built-in TypeScript support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.
* **Built-in TypeScript Support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Timer, @lfades suggested that this was redundant and the readme should directly link to https://nextjs.org/learn instead. Please let me know what you think, and if I should keep this on the Next.js readme.

@ijjk
Copy link
Member

ijjk commented Jul 23, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 13.3s 13.4s ⚠️ +69ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +196 B
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.151 2.086 -0.06
/ avg req/sec 1162.02 1198.66 +36.64
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.395 1.288 -0.11
/error-in-render avg req/sec 1792.47 1940.72 +148.25
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 946 B 946 B
link.html gzip 952 B 952 B
withRouter.html gzip 938 B 938 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 14.7s 14.6s -12ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +196 B
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 881 kB 881 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 881 kB 881 kB
link.js 922 kB 922 kB
routerDirect.js 916 kB 916 kB
withRouter.js 916 kB 916 kB
Overall change 4.52 MB 4.52 MB
Commit: cd7d7b8

packages/next/README.md Outdated Show resolved Hide resolved
@ijjk
Copy link
Member

ijjk commented Jul 24, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 12.2s 12.8s ⚠️ +529ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +159 B
Page Load Tests Overall increase ✓
vercel/next.js canary MehediH/next.js canary Change
/ failed reqs 0 0
/ total time (seconds) 2.092 2.107 ⚠️ +0.02
/ avg req/sec 1195.16 1186.51 ⚠️ -8.65
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.4 1.383 -0.02
/error-in-render avg req/sec 1785.27 1807.22 +21.95
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Rendered Page Sizes
vercel/next.js canary MehediH/next.js canary Change
index.html gzip 946 B 946 B
link.html gzip 952 B 952 B
withRouter.html gzip 938 B 938 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary MehediH/next.js canary Change
buildDuration 13.9s 13.7s -241ms
nodeModulesSize 66.4 MB 66.4 MB ⚠️ +159 B
Client Bundles (main, webpack, commons)
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..d2f7.js gzip 10.1 kB 10.1 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
main-8da3811..3b61.js gzip 6.72 kB 6.72 kB
polyfills-05..1236.js gzip 30.8 kB 30.8 kB
webpack-488d..c0e7.js gzip 751 B 751 B
Overall change 87.6 kB 87.6 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary MehediH/next.js canary Change
677f882d2ed8..dule.js gzip 6.1 kB 6.1 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
main-43a8e8b..dule.js gzip 5.79 kB 5.79 kB
polyfills-05..dule.js gzip 30.8 kB 30.8 kB
webpack-4f62..dule.js gzip 751 B 751 B
Overall change 82.6 kB 82.6 kB
Client Pages
vercel/next.js canary MehediH/next.js canary Change
_app-8f5f611..1f7b.js gzip 1.28 kB 1.28 kB
_error-8e69b..8695.js gzip 3.41 kB 3.41 kB
hooks-f7f3d0..7465.js gzip 887 B 887 B
index-08fb3f..c0e9.js gzip 227 B 227 B
link-ddd176e..5566.js gzip 1.29 kB 1.29 kB
routerDirect..8aa1.js gzip 284 B 284 B
withRouter-f..e777.js gzip 284 B 284 B
Overall change 7.66 kB 7.66 kB
Client Pages Modern
vercel/next.js canary MehediH/next.js canary Change
_app-669dbe5..dule.js gzip 626 B 626 B
_error-663e6..dule.js gzip 2.24 kB 2.24 kB
hooks-805c40..dule.js gzip 387 B 387 B
index-6ba5a4..dule.js gzip 226 B 226 B
link-69bc264..dule.js gzip 1.25 kB 1.25 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-d..dule.js gzip 282 B 282 B
Overall change 5.29 kB 5.29 kB
Client Build Manifests
vercel/next.js canary MehediH/next.js canary Change
_buildManifest.js gzip 275 B 275 B
_buildManife..dule.js gzip 281 B 281 B
Overall change 556 B 556 B
Serverless bundles
vercel/next.js canary MehediH/next.js canary Change
_error.js 881 kB 881 kB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 881 kB 881 kB
link.js 922 kB 922 kB
routerDirect.js 916 kB 916 kB
withRouter.js 916 kB 916 kB
Overall change 4.52 MB 4.52 MB
Commit: af65835

packages/next/README.md Outdated Show resolved Hide resolved
Copy link
Member

@lfades lfades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MehediH Thank you!

@lfades lfades merged commit 00ebce5 into vercel:canary Jul 24, 2020
kodiakhq bot pushed a commit that referenced this pull request Aug 3, 2020
Following up from #14830, this PR adds a new page to the docs for Create Next App. The content is identical to the README created as part of #14830. 

Also added a link on the main `getting-started` page to the new docs for Create Next App to help users find more info on Create Next App if needed. 

I'm unsure as to whether the content for the documentation needs to be different from the one I wrote for the README. Please let me know if that's the case, and I will be happy to tweak the structure.
@vercel vercel locked as resolved and limited conversation to collaborators Jan 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
create-next-app Related to our CLI tool for quickly starting a new Next.js application. type: next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Searching "create next app cli" on Google returns the wrong search result
4 participants