aboutsummaryrefslogtreecommitdiff
path: root/examples/next/README.md
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-15 20:08:40 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-15 20:08:40 -0700
commitcf2e81b03662c4b1a227d1bc9560a91826ef20e6 (patch)
tree0dc03cb97af1eb0615b8bb491696247962a81b73 /examples/next/README.md
parent0baa3b511e28cfb124f712e12d8f93474e6ce6fa (diff)
parentbf2732599cc7e45f320f75b38672c1a1fc3d5583 (diff)
downloadbun-cf2e81b03662c4b1a227d1bc9560a91826ef20e6.tar.gz
bun-cf2e81b03662c4b1a227d1bc9560a91826ef20e6.tar.zst
bun-cf2e81b03662c4b1a227d1bc9560a91826ef20e6.zip
Merge branch 'jarred/gen'
Diffstat (limited to 'examples/next/README.md')
-rw-r--r--examples/next/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/examples/next/README.md b/examples/next/README.md
new file mode 100644
index 000000000..b12f3e33e
--- /dev/null
+++ b/examples/next/README.md
@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.