aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorLofiSu <linsu269@gmail.com>2025-01-26 22:34:40 +0800
committerLofiSu <linsu269@gmail.com>2025-01-26 22:34:40 +0800
commitcd8aab3a511091ce378ff7ebcaa42bf979f00882 (patch)
treec387ca55aa6977499b03346ab46e63a0f7c09b36 /README.md
parent778f5b627812f6cb487e9236ca5e5261fd2e763c (diff)
downloadHydroRollSite-cd8aab3a511091ce378ff7ebcaa42bf979f00882.tar.gz
HydroRollSite-cd8aab3a511091ce378ff7ebcaa42bf979f00882.zip
refactor: rewrite
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 28 insertions, 42 deletions
diff --git a/README.md b/README.md
index 74872fd..e215bc4 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,36 @@
-# React + TypeScript + Vite
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+## Getting Started
-Currently, two official plugins are available:
+First, run the development server:
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
-## Expanding the ESLint configuration
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-- Configure the top-level `parserOptions` property like this:
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
-```js
-export default tseslint.config({
- languageOptions: {
- // other options...
- parserOptions: {
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: import.meta.dirname,
- },
- },
-})
-```
+## Learn More
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
- // Set the react version
- settings: { react: { version: '18.3' } },
- plugins: {
- // Add the react plugin
- react,
- },
- rules: {
- // other rules...
- // Enable its recommended rules
- ...react.configs.recommended.rules,
- ...react.configs['jsx-runtime'].rules,
- },
-})
-```
+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/app/building-your-application/deploying) for more details.