Marcos Bérgamo
c3e5caf110
docs(examples): improve DX while copying command to create new project ( #38410 )
...
* docs(examples): improve DX while copy command to create new project
* chore: apply code review
Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00
JJ Kasper
0ab6ad5241
Update default gitignore templates ( #39051 )
2022-07-26 20:08:40 -05:00
Steven
57dcc9d329
Update pnpm create next-app
for latest pnpm 6 and 7 ( #37254 )
...
This command changed in pnpm [6.32.13](https://github.com/pnpm/pnpm/releases/tag/v6.32.13 ) and [7.1.1](https://github.com/pnpm/pnpm/releases/tag/v7.1.1 ) so lets update it since its been a few weeks and we can expect pnpm users to update more regularly than npm users.
- Fixes https://github.com/vercel/next.js/pull/37240
- Fixes https://github.com/vercel/next.js/pull/37045
- Fixes https://github.com/vercel/next.js/pull/37032
- Fixes https://github.com/vercel/next.js/pull/36602
- Fixes https://github.com/vercel/next.js/pull/36496
2022-05-27 21:21:40 +00:00
Tom
3e178bb801
add pnpm link to docs ( #37221 )
...
## Documentation / Examples
- [x] Make sure the linting passes by running `yarn lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples )
Co-authored-by: Steven <steven@ceriously.com>
2022-05-27 15:46:38 -04:00
Steven
9f9214abe5
Updated create-next-app docs to include pnpm usage ( #35755 )
...
This PR updates the docs and examples for `create-next-app` to include pnpm usage.
The following script was used to update every example README:
```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')
for (let example of examples) {
const filename = `./examples/${example}/README.md`
const markdown = fs.readFileSync(filename, 'utf8')
const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
const output = markdown.replace(regex, (yarn, group) => {
const pnpm = `pnpm create next-app -- --example ${group}`
return `${yarn}\n# or\n${pnpm}`
})
fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +00:00
Hassan El Mghari
33aa51ab26
Change README structure in examples ( #35349 )
...
Changed the README structure in all examples to take out the Stackblitz button and include it as a link instead using a [bash script](https://gist.github.com/Nutlope/a8f3556a5a401e32a8c6278b782ebf8a/revisions ).
I also added the Vercel deploy button to 15 READMEs that didn't have it.
2022-03-16 21:39:26 +00:00
Luc Leray
f52955ec94
Clean up examples package.json
( #27121 )
...
Clean up package.json files in the `examples` directory:
- Add `private: true`
- Remove `version` (because they are irrelevant for packages that are not meant to be published)
- Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
- Remove `author`
- Remove `description`
- Remove `license`
Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (https://github.com/vercel/next.js/pull/27121#discussion_r668178408 ).
## Documentation / Examples
- [x] Make sure the linting passes
2021-07-12 19:58:03 +00:00
Nick Babcock
5629223407
Update examples to use React 17 ( #26133 )
...
[With next 11 requiring react 17](https://nextjs.org/blog/next-11#upgrade-guide ), most of the examples
need to be updated, so the following snippet updated all the examples to
a compatible react version.
```bash
cd examples/
fd -g 'package.json' | xargs sed -r -i 's/"react": ".*"/"react": "^17.0.2"/
fd -g 'package.json' | xargs sed -r -i 's/"react-dom": ".*"/"react-dom": "^17.0.2"/'
# exclude experimental react version
git checkout with-reason-relay/package.json
```
2021-06-16 16:43:26 +00:00
Vitaly Baev
fb5418ea32
(examples/with-react-md): switch from node-sass to sass ( #26001 )
...
## Documentation / Examples
- [x] Make sure the linting passes
Continuing fixing #25854
Switching from `node-sass` to `sass`
2021-06-11 22:58:00 +00:00
Luis Alvarez D
0370c037fc
Update links that go to vercel.com/now ( #21556 )
2021-01-26 18:59:01 +00:00
Luc Leray
8eaabe2fb0
Fix deploy buttons URLs ( #20834 )
...
Fix all deploy button URLs in the Next.js repo to follow the following format:
```
https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/ <EXAMPLE_NAME>&project-name=<EXAMPLE_NAME>&repository-name=<EXAMPLE_NAME>
```
The detailed docs for the Deploy Button can be found here: https://vercel.com/docs/more/deploy-button .
Also updates legacy Vercel import flow URLs (starting with vercel.com/import or with vercel.com/new/project), to use the new vercel.com/new URLs.
---
For example, for the `hello-world` example:
The URL is https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world
And the deploy button looks like this:
[![Deploy with Vercel](https://vercel.com/button )](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world )
---
For reference, I used the following regexes to search for the incorrect URLs
```
\(https://vercel.com/import/git\?s=https://github.com/vercel/next.js/tree/canary/examples/(.*) \)
\(https://vercel.com/import/git\?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/ ([^&]*)(.*)\)
\(https://vercel.com/import/project\?template=https://github.com/vercel/next.js/tree/canary/examples/(.*) \)
https://vercel.com/import/git
https://vercel.com/import/select-scope
https://vercel.com/import
https://vercel.com/new/project
```
2021-01-07 01:40:29 +00:00
Joe Haddad
f17d435166
Ensure all examples are MIT licensed ( #16691 )
2020-08-29 22:32:35 -04:00
NorbertLuszkiewicz
c03d4931de
Simplify example usage instructions ( #16678 )
...
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-08-29 22:22:02 -04:00
Mikkel Laursen
9ef0fae889
[Examples] Update react-md examples for v2 ( #15723 )
2020-08-05 14:24:20 -04:00
Darsh Patel
8f888c9f90
Update react-md url for with-react-md ( #15325 )
...
Low hanging fruit 🍎
Resolves : #15321
`https://react-md.mlaursen.com/ ` -> `https://react-md.dev/ `
2020-07-20 13:36:23 +00:00
Tanmay Laud
f00ad581a1
Added .gitignore to examples that are deployed to vercel ( #15127 )
...
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-07-16 10:52:23 -04:00
Joe Haddad
d650da0623
Remove refs to old css experiment ( #13673 )
...
Removes some dangling references to non-existent experimental options.
2020-06-02 16:57:35 +00:00
Joe Haddad
7d038dfef1
Suggest npx
over npm init
( #13637 )
...
This updates old examples to the more universal `npx` command.
Fixes https://github.com/vercel/next.js/discussions/12103
2020-06-01 17:36:57 +00:00
Joe Haddad
b7e17e09e5
Update references to zeit/next.js ( #13463 )
2020-05-27 17:51:11 -04:00
JJ Kasper
1f6ce106ae
Update codeload and deploy links for org rename ( #13141 )
...
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-05-27 14:11:39 -04:00
Joe Haddad
dbad9db68c
Update Examples for Fast Refresh ( #13068 )
2020-05-18 17:44:18 -04:00
Tim Neutkens
483bd3ddda
Rename ZEIT to Vercel ( #12075 )
...
* Find/replace
* Update more URLs
* More rename
* Fix remaining examples
* More updates
* Update create-next-app
* Update remaining text
* Update
Co-authored-by: Shu Uesugi <shu@chibicode.com>
2020-04-21 11:47:12 +02:00
Shu Uesugi
c57cdbb31d
Rename zeit.co/new → zeit.co/import ( #10674 )
...
* Replace zeit.co/new → zeit.co/import
* Update deployment.md
2020-02-24 19:08:34 -05:00
Shu Uesugi
5f041447bc
Remove Now CLI reference from examples ( #10501 )
...
* Find/Replace "Deploy it to the cloud..."
* Find/Replace "Deploy it to the cloud..." (no colon)
* Find/Replace "Deploy it to the cloud..." for firebase
* Convert remaining ones
* Storybook deployment
* Update with-stripe-typescript
* Update contributing.md
* Remove `now`
* Update examples/with-stripe-typescript/README.md
Co-Authored-By: Luis Alvarez D. <luis@zeit.co>
2020-02-12 17:14:57 -05:00
Shu Uesugi
6804039e94
Make example READMEs more consistent ( #10124 )
...
* npx create → npm init
* Fix inconsistent instructions
* Update amp-first
* Update with-graphql-react
* with-firebase-cloud-messaging
* Update with-higher-order-component
* change create-next-app url
* Update create-next-app instruction
* Update instructions to use npm instead of npx
* Move "the idea behind the example" to top
* Rename
* Rename
* Update contributing.md with a README template
2020-01-16 23:23:56 +01:00
Luis Alvarez D
7edf0da0c4
Add the deploy button to compatible examples ( #9547 )
2019-11-27 11:40:58 -05:00
Joe Haddad
6bf87b356d
Check formatting on build ( #9375 )
2019-11-10 20:29:49 -08:00
Joe Haddad
18a9c7e371
Improve linting rules to catch more errors ( #9374 )
...
* Update `packages/`
* Update examples
* Update tests
* Update bench
* Update top level files
* Fix build
* trigger
2019-11-10 19:24:53 -08:00
Luis Alvarez D
6c9fa8662c
Updated multiple examples to use /public ( #9033 )
2019-10-11 11:50:06 +02:00
Luis Alvarez D
f10f3304fe
Replace the deprecated Create Next App URL ( #9032 )
2019-10-10 23:34:14 -04:00
Connor Davis
3fa04620e7
Remove Deploy To Now buttons ( #7126 )
...
* Remove Deploy To Now buttons
* Remove remaining buttons
2019-04-24 10:53:58 +02:00
Juan Olvera
7e12997af6
Test updater script on examples folder ( #5993 )
...
I wrote a [script](https://github.com/j0lv3r4/dependency-version-updater ) to update dependencies recursively in `package.json` files, e.g.:
```
$ node index.js --path="./examples" --dependencies="react=^16.7.0,react-dom=^16.7.0"
```
This PR contains the result against the examples folder.
2019-01-05 12:19:27 +01:00
Tim Neutkens
9c4eefcdbf
Add prettier for examples directory ( #5909 )
...
* Add prettier for examples directory
* Fix files
* Fix linting
* Add prettier script in case it has to be ran again
2018-12-17 17:34:32 +01:00
Michael Herold
5b3578e58f
#4751 - Explicitly mention install when cloning examples ( #4758 )
...
Preferably this installation wouldn't be necessary, but in lieu of a fix...
#4751
2018-07-11 23:56:15 +02:00
James Hegedus
f2e56609cd
Examples: stabalise README format and create-next-app usage ( #4009 )
...
* Examples: clarify language around Yarn create & npx
* add missing READMEs and create-next-app usage
* suggest people tag jthegedus in firebase related issues
* add yarn alt instructions
* cerebraljs example readme & fixes
2018-04-03 14:19:05 +02:00
James Hegedus
b1d8b839dd
Examples: use npx and yarn create to run create-next-app on examples ( #4002 )
...
* remove global npm install of create-next-app
* add npx to create-next-app command in examples
* add bash to shell snippets
* add yarn create to next-app command in examples
* fix READMEs named with lowercase
* change READMEs to use UPPERCASE
2018-03-14 09:09:46 +01:00
Tim Neutkens
24c1ac6ca9
Use canary for all example downloads ( #3411 )
2017-12-06 18:12:42 -08:00
Fouad Matin
2528779394
examples: add create-next-app ( #3377 )
...
* examples: add create-next-app
* fix with-typescript readme
2017-12-02 20:30:17 -08:00
Tim Neutkens
47d3cfd0fd
Upgrade React for all examples ( #3113 )
2017-10-17 08:11:46 +02:00
Henrik
f14297dc80
Normalize example package.json files ( #2350 )
2017-06-23 10:46:44 +02:00
Tim Neutkens
2ea619658b
Fix react-md example
2017-05-13 00:42:39 +02:00
Paul Molluzzo
d08e027a8c
Add deploy now button to the top of all example READMEs ( #1763 )
...
* Add deploy now button to the top of all example READMEs
* Remove unnecessary whitespace changes
2017-04-22 14:51:51 +02:00
Tim Neutkens
7f0591896a
Use latest version of Next for all examples ( #1597 )
...
* Use latest for all examples
* Update yarn.lock
2017-04-03 09:46:35 +05:30
Vlad Frolov
1a61133dd4
fix(example): Added missing instructions for CSS "bundling" in with-react-md example ( #1451 ) ( #1456 )
2017-03-18 11:45:48 +01:00
Vlad Frolov
fca0a39cbc
examples/with-react-md: Fixed "Cannot read property 'focus' of undefined" ( #961 )
2017-02-02 22:56:07 +01:00
Tim Neutkens
61bdae5a08
Fix typo in react-md example readme ( #959 )
2017-02-02 20:00:45 +01:00
Vlad Frolov
0a2466a36e
Added React-MD example ( #940 )
2017-02-02 13:10:59 +01:00