docs: readme and pull request template (#247)

* docs: README
* docs: pull request template

* Update README.md
Co-authored-by: Flouse <[email protected]>

---------

Co-authored-by: Flouse <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+<!-- PULL REQUEST TEMPLATE -->
+<!-- (Update "[ ]" to "[x]" to check a box) -->
+
+**What kind of change does this PR introduce?** (check at least one)
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update
+- [ ] Refactor
+- [ ] Build-related changes
+- [ ] Other, please describe:
+
+**The PR fulfills these requirements:**
+
+- [ ] It's submitted to the `develop` branch(or to a previous version branch), _not_ the `main` branch
+- [ ] All tests are passing
+- [ ] Build success
+
+If adding a **new feature**, the PR's description includes:
+- [ ] A convincing reason for adding this feature
+
+**Other information:**

README.md

@@ -0,0 +1,13 @@
+<p align="center"><a href="https://explorer.rgbpp.io" target="_blank" rel="noopener noreferrer"><img height="60px" src="https://explorer.rgbpp.io/logo.svg" alt="rgb++ explorer logo"></a></p>
+
+<h1 align="center">The RGB++ Explorer Open Source Project</h1>
+
+RGB++ Explorer is a RGB++ protocol blockchain explorer built with Next.js and Nest.JS and includes two parts: [Frontend](./frontend) and [Backend](./backend).
+
+See live at [RGB++ Explorer](https://explorer.rgbpp.io) and [Testnet](https://testnet.explorer.rgbpp.io).
+
+## About [RGB++](https://www.rgbppfans.com/)
+RGB++ is an extension protocol based on RGB that utilizes single-use seals and client-side verification techniques to manage state changes and transaction validation. It maps Bitcoin UTXOs to Nervos CKB cells through isomorphic binding and leverages script constraints on both the CKB and Bitcoin chains to verify the correctness of state calculations and the validity of ownership transfers.
+
+RGB++ addresses the technical challenges of the original RGB protocol in real-world applications and offers additional possibilities, such as blockchain-enhanced client-side verification, transaction folding, shared state across contracts, and non-interactive transfers. It brings Turing-complete contract scalability and performance enhancements to Bitcoin without the need for cross-chain interactions and without compromising security.
+

frontend/README.md

@@ -1,39 +1,66 @@
-# RGB++ Explorer
+# RGB++ Explorer Frontend
 
-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).
+## Component Library
 
-## Getting Started
+This project uses **Park UI** and **Pandacss** as the component library, providing a set of reusable UI components that enhance the overall user experience.
 
-First, run the development server:
+## Multilingual Solution
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+For handling multilingual support, we use **Lingui**. This library allows for efficient extraction, compilation, and management of translations in the application.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Minimum Version Requirements
 
-You can start editing the page by modifying `app/layout.tsx`. The page auto-updates as you edit the file.
+To run this project, ensure you have the following minimum versions installed:
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+- **Node.js**: 20.x or higher
+- **pnpm**: v9.4 or higher
 
-## Learn More
+### Package Manager
 
-To learn more about Next.js, take a look at the following resources:
+This project uses `pnpm` as the package manager. Ensure you have `pnpm` installed. If not, you can install it globally with:
 
-- [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 install -g pnpm
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+### Installation
+```bash
+pnpm install
+```
 
-## Deploy on Vercel
+### Startup Instructions
+To start the development server, run:
+```bash
+pnpm dev
+```
+This command will start the Next.js application in development mode. You can access the application at [`http://localhost:3000`](http://localhost:3000).
 
-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.
+### Build
+To create a production build, run:
+```bash
+pnpm build
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+After building, you can start the production server with:
+
+```bash
+pnpm start
+```
+### Linting and Code Formatting
+To lint your code, use:
+```bash
+pnpm lint
+```
+
+To check for spelling errors, run:
+```bash
+pnpm cspell
+```
+
+To extract and compile translations, use:
+```bash
+pnpm lingui
+```
 
+## Contributing
+Contributions are welcome! Please open an issue or submit a pull request.