-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
38 changed files
with
6,943 additions
and
3,859 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<div align="center"> | ||
|
||
<!-- <h3>Farm-react Starter Template</h3> --> | ||
<p> | ||
<img src="./src/assets/logo.png" width="30" align="center" /> | ||
An out-of-the-box Farm-react development template | ||
</p> | ||
<p align="center"> | ||
<a href="https://discord.gg/mDErq9aFnF"> | ||
<img src="https://img.shields.io/badge/chat-discord-blueviolet?style=flat&logo=discord&colorA=ffe3f5&colorB=711a5f" alt="discord chat" /> | ||
</a> | ||
<a href="https://npmjs.com/package/@farmfe/core"> | ||
<img src="https://img.shields.io/npm/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="npm package"> | ||
</a> | ||
<a href="https://nodejs.org/en/about/releases/"> | ||
<img src="https://img.shields.io/node/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="node compatibility"> | ||
</a> | ||
<a href="https://github.com/farm-fe/farm/blob/main/LICENSE"> | ||
<img src="https://img.shields.io/npm/l/@farmfe/core?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="license" /> | ||
</a> | ||
</p> | ||
<br/> | ||
</div> | ||
|
||
<p> | ||
<img src="https://github.com/jstors/assets/blob/main/home.jpeg" align="center" /> | ||
</p> | ||
|
||
> For a better development experience, please install the [**Biome plugin**](https://biomejs.dev/en/reference/vscode/) on your local development tool. | ||
|
||
## RoadMap | ||
|
||
[RoadMap](https://github.com/jstors/farm-react-template/issues/21) | ||
|
||
## Usage | ||
|
||
### User Configuration | ||
|
||
All configuration files are located in the `config` directory and can be modified according to your needs. | ||
- `config/const.ts`: Contains constants used in the project. | ||
- `config/menu.ts`: Menu configuration | ||
|
||
## Integrated Features | ||
- [Farm](https://farm-fe.github.io/en/docs/quick-start): A Rust-based foundation framework that provides a complete development experience. | ||
- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): A Rust-based linting and formatting tool that enhances the development experience. | ||
- [Ant Design](https://ant.design/components/overview-cn/): An out-of-the-box React component library, use version 5.x. | ||
- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): Provides a routing system based on conventions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
{ | ||
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json", | ||
"organizeImports": { | ||
"enabled": true | ||
}, | ||
"linter": { | ||
"enabled": true, | ||
"rules": { | ||
"recommended": true, | ||
"a11y": { | ||
"useButtonType": "off", | ||
"useKeyWithClickEvents": "off" | ||
}, | ||
"correctness": { | ||
"useExhaustiveDependencies": "warn" | ||
} | ||
} | ||
}, | ||
"formatter": { | ||
"enabled": true, | ||
"lineWidth": 120, | ||
"indentStyle": "space", | ||
"indentWidth": 2 | ||
}, | ||
"javascript": { | ||
"formatter": { | ||
"quoteStyle": "single" | ||
} | ||
} | ||
"$schema": "https://biomejs.dev/schemas/1.6.1/schema.json", | ||
"organizeImports": { | ||
"enabled": true | ||
}, | ||
"linter": { | ||
"enabled": true, | ||
"rules": { | ||
"recommended": true, | ||
"a11y": { | ||
"useButtonType": "off", | ||
"useKeyWithClickEvents": "off" | ||
}, | ||
"correctness": { | ||
"useExhaustiveDependencies": "off" | ||
} | ||
} | ||
}, | ||
"formatter": { | ||
"enabled": true, | ||
"lineWidth": 120, | ||
"indentStyle": "space", | ||
"indentWidth": 2 | ||
}, | ||
"javascript": { | ||
"formatter": { | ||
"quoteStyle": "single" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/** | ||
* 系统信息 | ||
*/ | ||
const adminInfo = { | ||
title: 'Farm React Admin', | ||
}; | ||
|
||
/** | ||
* 主题配置 | ||
*/ | ||
const theme = { | ||
token: { | ||
colorPrimary: '#9d4edc', | ||
colorInfo: '#9d4edc', | ||
}, | ||
cssVar: { | ||
prefix: 'farm', | ||
}, | ||
}; | ||
|
||
export { adminInfo, theme }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.