nav | toc | title | ||||
---|---|---|---|---|---|---|
|
content |
Get Started |
React-Next-Admin
The next generation of admin enterprise applications with awesome architecture, x3 time faster development and better performance Preview:
https://react-admin-pro.netlify.app
Features
- Umi - React Framework: File-based routing(V6), auto importing, plugins(role/i18n etc), micro-front-end etc.
- π‘ TypeScript, of course 100%
- β State management: Umi Model(context with selector) / Valtio (Proxy Base)
- β Apollo GraphQL: auto generator base on gql schema
- π¨ UnoCSS - The instant on-demand atomic CSS engine (Uno,Tailwind,Bootstrap...)
- π Use UnoCSS icons in Pure CSS, small bundles
- π Antd V5: Beautiful, Fast, enterprise UI components
- β Antd Procomponents - Template component, Layout/Skeleton/Table/Form/Validation/Charts
- π± Responsive: Designed for variable screen sizes
- π¨ Theming and layout: Customizable with theme editor and layout editor
- π AHooks: high-quality & reliable React Hooks library
- π International: Built-in i18n
- βοΈ Best Practices: Solid workflow to make your code healthy
- Eslint & Prettier: lint system to improve our code clean and consistency
- β Husky & Commitlint: commits with rule Commit convention (feat|chore|fix..: 'first commit' )
- β Custom VsCode Snippets
- β Mock development: Easy to use mock development solution
- β UI Test (cypress,Jest): Fly safely with unit and e2e tests
- β Page Tab: multi-page navigation like chrome with persistent support
- β Documents/DevTool: use Dumi for writing doc and Floating dev tools browsing view in one place
TODO
- CRUD components
Teach Stack & Preparation
- node and git - Project development environment
- Webpack MFSU - Familiar with Webpack features
- React - React] official website:
- TypeScript - Familiar with the basic syntax of
TypeScript
- Es6+ - Familiar with es6 basic syntax
- Vue-Router-Next - Familiar with the basic use of vue-router
- Ant-Design V5 - Enterprise UI library
- Antd procomponents - Antd procomponent
file structure
βββ README.md //Description file
βββ config //Configuration directory
β βββ config.dev.ts //Online development environment configuration file
β βββ config.local.ts //local development environment configuration file
β βββ config.pro.ts //Online official environment configuration file
β βββ config.testing.ts //Online test environment configuration file
β βββ config.ts //General configuration entry file
β βββ layout.ts //background layout configuration file
β βββ dumi.ts //dumi document configuration
β βββ theme.ts //Global style variable configuration
β βββ proxy.ts //Proxy configuration file
β βββ routes.ts //routing configuration file
βββ docs //public documentation directory
β βββ demo.md //document description example
βββ mock //mock mock data directory
β βββ api.ts
βββ package.json
βββ public
β βββ favicon.ico
βββ src
β βββ typings.d.ts //ts type declaration
β βββ access.ts //umijs layout permission verification hook
β βββ app.ts //umijs convention runtime configuration file
β βββ assets //resource storage directory
β β βββ images
β βββ components //Component directory
β β βββ ErrorBoundary //Global error capture component
β β βββ FormCustom //Form package component
β β βββ Exception //Grouping of components such as global exceptions
β β βββ RightContent //Top bar component
β β βββ TableCustom //Table package component
β βββ global.css //Global style file
β βββ layouts //The global routing public layout can be used optionally
β β βββ index.tsx
β βββ locales //Internationalization
β β βββ en-US.js
β β βββ zh-CN.js
β βββ models //Global state directory named XXXXModel interface
β β βββ globalUserModel.ts //dva writing
β β βββ useGlobalModel.ts //umijs writing
β β βββ useUserModel.ts
β βββ pages
β β βββ document.ejs //html file configuration
β βββ hooks //Custom hooks storage folder
β β βββ usexxxx.ts
β βββ services //request directory
β β βββ config.ts //Request interceptor
β β βββ handler.ts //Request type encapsulation
β β βββ index.ts //Storage request
β βββ e2e //Browser test
β β βββ baseLayout.e2e.js //public test file format routes automatic test page
β βββ utils //The directory for storing public tools or methods
β βββ globalUtils.ts //Global method, automatically loaded to the global when webpack compiles
β βββ utils.test.ts //function test
β βββ index.ts //Business public use separately
βββ tests //Automatic test extension writing
βββ tsconfig.json //ts configuration file
Use Gitpod
Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
[![Open in Gitpod] soon
Development
Local development environment: pnpm start
Online development environment: pnpm build:dev
Online testing environment: pnpm build:testing
Online production environment: pnpm build
Browsers support
Modern browsers.
Edge |
Firefox |
Chrome |
Safari |
Opera |
---|---|---|---|---|
Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
Contributing
Any type of contribution is welcome, here are some examples of how you may contribute to this project:
- Use
React Next Admin
in your daily work. - Submit issues to report bugs or ask questions.