Updated README

This commit is contained in:
qt-coder 2021-06-21 12:27:03 +08:00
parent 1c703a9a20
commit 22e81517f4

View file

@ -1,34 +1,48 @@
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
# Cath.gq
First, run the development server:
Cath.gq is the dashboard for its parent project, [Cath.exe](https://github.com/night0721/cath.exe)
## Run Locally
Clone the project
```bash
npm run dev
# or
yarn dev
git clone https://github.com/night0721/cath.gq.git
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Go to the project directory
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
```bash
cd cath.gq
```
[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`.
Install dependencies
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.
```bash
yarn install
```
## Learn More
Start the server
To learn more about Next.js, take a look at the following resources:
```bash
npm run dev
```
- [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.
## License
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
[MIT](https://choosealicense.com/licenses/mit/)
## Deploy on Vercel
## Demo
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.
[Live](https://cath.gq)
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## Authors
- [@qt-coder](https://www.github.com/qt-coder)