docs: add README
This commit is contained in:
61
README.md
61
README.md
@@ -1,36 +1,53 @@
|
||||
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).
|
||||
# 资源下载网站
|
||||
|
||||
## Getting Started
|
||||
基于 Next.js 构建的内网 APK 资源下载工具。
|
||||
|
||||
First, run the development server:
|
||||
## 功能
|
||||
|
||||
- 按项目、版本搜索 APK 文件
|
||||
- 支持按 commit id 过滤
|
||||
- 简单的用户认证
|
||||
- 简洁美观的界面
|
||||
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
访问 http://localhost:3000
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
## 环境变量
|
||||
|
||||
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.
|
||||
在 `.env.local` 中配置:
|
||||
|
||||
## Learn More
|
||||
```env
|
||||
AUTH_USERNAME=admin
|
||||
AUTH_PASSWORD=changeme
|
||||
RESOURCE_PATH=/Users/tech/workspace/n3-world/handy-tools/ftdl
|
||||
```
|
||||
|
||||
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.
|
||||
```bash
|
||||
npm run build
|
||||
npm start
|
||||
```
|
||||
|
||||
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.
|
||||
```
|
||||
RESOURCE_PATH/
|
||||
├── FT/
|
||||
│ ├── 0_42/
|
||||
│ │ └── apks/
|
||||
│ │ └── *.apk
|
||||
│ └── 0_44/
|
||||
│ └── apks/
|
||||
│ └── *.apk
|
||||
├── FT_DEV/
|
||||
│ └── ...
|
||||
└── FT_Rustore/
|
||||
└── ...
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user