|
|
@@ -1,12 +1,28 @@
|
|
|
-# Introduction
|
|
|
+## Introduction
|
|
|
|
|
|
-This is seed version of Mantis Theme. Seed is very minimal version of theme. It has just one authentication method with sample page in dashboard. Except mentioned above, all the unreferenced things has been removed. No extra packages, components, apis. Seed has been targeted for users who just need aesthetic and MUI from project, rest they wanted to manage their own like state, api and many other things.
|
|
|
+This is a frontend that is almost fully compatible with the V2Board API, offering more features and customizability than the original v2board-user frontend.
|
|
|
+We built this project using React + Redux + Material UI, without the `antd` package but following the style of Ant Design.
|
|
|
+As a service provider whose customers are mostly from mainland China, we need to make a frontend that conforms to the usage habits of Chinese people as much as possible.
|
|
|
|
|
|
-# Getting Started
|
|
|
+## Development
|
|
|
|
|
|
-1. Installation process
|
|
|
- - run 'npm install / yarn'
|
|
|
- - start dev server run 'npm run start / yarn start'
|
|
|
-2. Deployment process
|
|
|
- - Goto root directory and open package.json. Update homepage URL to the production URL
|
|
|
- - Goto root directory and run 'npm run build / yarn build'
|
|
|
+First of all, you need to pay attention: According to the AGPL-3.0 agreement, as long as you modify our code, no matter whether you publish this code or only use the code to provide services, you need to open source your code.
|
|
|
+Our open source behavior is to build a better open source ecosystem. If you can not respect and follow the rules of the opensource community, please do not use our code.
|
|
|
+If you use our code illegally, then we will actively collect evidence and initiate lawsuits against you and your company.
|
|
|
+
|
|
|
+1. Installation
|
|
|
+ - fork this repository, and then clone it to your computer.
|
|
|
+ - download pnpm. (https://pnpm.io/installation)
|
|
|
+ - run `pnpm install` in the project directory.
|
|
|
+2. Development process
|
|
|
+ - start dev server run `pnpm start`
|
|
|
+ - go to http://localhost:3000 for development
|
|
|
+3. Deployment process
|
|
|
+ - commit code to GitHub via `git commit` and `git push`
|
|
|
+ - run `pnpm run build` to build the production version
|
|
|
+ - upload files in the `dist` directory to your server
|
|
|
+ - go to http://yourdomain.com for production
|
|
|
+
|
|
|
+## License Scanning
|
|
|
+
|
|
|
+[](https://app.fossa.com/projects/git%2Bgithub.com%2Fstar-horizon%2Fgfwservice-frontend?ref=badge_large)
|
AH-dark