142 lines
6.1 KiB
Markdown
142 lines
6.1 KiB
Markdown
<a name="readme-top"></a>
|
||
|
||
<div align="center">
|
||
|
||
<img width="160" src="https://raw.githubusercontent.com/perfect-panel/ppanel-assets/refs/heads/main/logo.svg">
|
||
|
||
<h1>PPanel admin web</h1>
|
||
|
||
This is a PPanel admin web powered by PPanel
|
||
|
||
English
|
||
·
|
||
[Chinese](./README.zh-CN.md)
|
||
·
|
||
[Changelog](../../CHANGELOG.md)
|
||
·
|
||
[Report Bug][issues-link]
|
||
·
|
||
[Request Feature][issues-link]
|
||
|
||
<!-- SHIELD GROUP -->
|
||
|
||
[![][github-release-shield]][github-release-link]
|
||
[![][github-releasedate-shield]][github-releasedate-link]
|
||
[![][github-action-test-shield]][github-action-test-link]
|
||
[![][github-action-release-shield]][github-action-release-link]<br/>
|
||
[![][github-contributors-shield]][github-contributors-link]
|
||
[![][github-forks-shield]][github-forks-link]
|
||
[![][github-stars-shield]][github-stars-link]
|
||
[![][github-issues-shield]][github-issues-link]
|
||
[![][github-license-shield]][github-license-link]
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<details>
|
||
<summary><kbd>Table of contents</kbd></summary>
|
||
|
||
#### TOC
|
||
|
||
- [⌨️ Local Development](#️-local-development)
|
||
- [🚀 Deploy on Vercel](#-deploy-on-vercel)
|
||
- [🤝 Contributing](#-contributing)
|
||
- [📝 License](#-license)
|
||
|
||
####
|
||
|
||
</details>
|
||
|
||
## ⌨️ Local Development
|
||
|
||
You can use Github Codespaces for online development:
|
||
|
||
[![][codespaces-shield]][codespaces-link]
|
||
|
||
You can use Gitpod for online development:
|
||
|
||
[][gitpod-link]
|
||
|
||
or clone it for local development:
|
||
|
||
```bash
|
||
git clone https://github.com/perfect-panel/ppanel-web.git
|
||
cd ppanel-web
|
||
|
||
# Install dependencies
|
||
bun install
|
||
|
||
# Run the development server
|
||
cd apps/admin
|
||
bun dev
|
||
```
|
||
|
||
Open <http://localhost:3000> with your browser to see the result.
|
||
|
||
## 🚀 Deploy on Vercel
|
||
|
||
[](https://vercel.com/new/clone?demo-description=PPanel%20is%20a%20pure%2C%20professional%2C%20and%20perfect%20open-source%20proxy%20panel%20tool%2C%20designed%20to%20be%20your%20ideal%20choice%20for%20learning%20and%20practical%20use&demo-image=https%3A%2F%2Furlscan.io%2Fliveshot%2F%3Fwidth%3D1920%26height%3D1080%26url%3Dhttps%3A%2F%2Fadmin.ppanel.dev&demo-title=PPanel%20Admin%20Web&demo-url=https%3A%2F%2Fadmin.ppanel.dev%2F&from=.&project-name=ppanel-admin-web&repository-name=ppanel-web&repository-url=https%3A%2F%2Fgithub.com%2Fperfect-panel%2Fppanel-web&root-directory=apps%2Fadmin&skippable-integrations=1)
|
||
|
||
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.
|
||
|
||
## 🤝 Contributing
|
||
|
||
Contributions of all types are more than welcome,
|
||
if you're interested in contributing code, feel free to check out our GitHub
|
||
[Issues][github-issues-link] to get stuck in to show us what you’re made of.
|
||
|
||
[![][pr-welcome-shield]][pr-welcome-link]
|
||
|
||
[![][contributors-contrib]][contributors-url]
|
||
|
||
<div align="right">
|
||
|
||
[![][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
## 📝 License
|
||
|
||
Copyright © 2024 [PPanel][profile-link]. <br />
|
||
This project is [GNU](../../LICENSE) licensed.
|
||
|
||
<!-- LINK GROUP -->
|
||
|
||
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
|
||
[codespaces-link]: https://codespaces.new/perfect-panel/ppanel-web
|
||
[codespaces-shield]: https://github.com/codespaces/badge.svg
|
||
[contributors-contrib]: https://contrib.rocks/image?repo=perfect-panel/ppanel-web
|
||
[contributors-url]: https://github.com/perfect-panel/ppanel-web/graphs/contributors
|
||
[github-action-release-link]: https://github.com/perfect-panel/ppanel-web/actions/workflows/release.yml
|
||
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-web/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
|
||
[github-action-test-link]: https://github.com/perfect-panel/ppanel-web/actions/workflows/test.yml
|
||
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-web/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
|
||
[github-contributors-link]: https://github.com/perfect-panel/ppanel-web/graphs/contributors
|
||
[github-contributors-shield]: https://img.shields.io/github/contributors/perfect-panel/ppanel-web?color=c4f042&labelColor=black&style=flat-square
|
||
[github-forks-link]: https://github.com/perfect-panel/ppanel-web/network/members
|
||
[github-forks-shield]: https://img.shields.io/github/forks/perfect-panel/ppanel-web?color=8ae8ff&labelColor=black&style=flat-square
|
||
[github-issues-link]: https://github.com/perfect-panel/ppanel-web/issues
|
||
[github-issues-shield]: https://img.shields.io/github/issues/perfect-panel/ppanel-web?color=ff80eb&labelColor=black&style=flat-square
|
||
[github-license-link]: https://github.com/perfect-panel/ppanel-web/blob/master/LICENSE
|
||
[github-license-shield]: https://img.shields.io/github/license/perfect-panel/ppanel-web?color=white&labelColor=black&style=flat-square
|
||
[github-release-link]: https://github.com/perfect-panel/ppanel-web/releases
|
||
[github-release-shield]: https://img.shields.io/github/v/release/perfect-panel/ppanel-web?style=flat-square&sort=semver&logo=github
|
||
[github-releasedate-link]: https://github.com/perfect-panel/ppanel-web/releases
|
||
[github-releasedate-shield]: https://img.shields.io/github/release-date/perfect-panel/ppanel-web?labelColor=black&style=flat-square
|
||
[github-stars-link]: https://github.com/perfect-panel/ppanel-web/network/stargazers
|
||
[github-stars-shield]: https://img.shields.io/github/stars/perfect-panel/ppanel-web?color=ffcb47&labelColor=black&style=flat-square
|
||
[gitpod-link]: https://gitpod.io/#https://github.com/perfect-panel/ppanel-web
|
||
[issues-link]: https://github.com/perfect-panel/ppanel-web/issues/new/choose
|
||
[pr-welcome-link]: https://github.com/perfect-panel/ppanel-web/pulls
|
||
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
|
||
[profile-link]: https://github.com/perfect-panel
|