Skip to content

Commit

Permalink
add readme and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
inside committed Dec 5, 2023
1 parent 1c7830f commit e539c40
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 34 deletions.
49 changes: 15 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,21 @@
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).
# Installation

## Getting Started
1. Clone this repo
1. `npm install`
1. `npm run build`
1. `npm start`

First, run the development server:
# Steps to reproduce

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
1. Open your browser to `http://localhost:3000`
1. Open the devtools
1. Go to the network tab
1. Notice each additional `_next/data` request for each link to a page

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
![network tab](network-tab.png)

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
1. Click on either of the request
1. Click on the `Response` tab
1. Notice the empty json response like this `{}`

[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.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## 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.
![request response](request-response.png)
Binary file added network-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added request-response.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e539c40

Please sign in to comment.