rahmatcmos / react-next-admin

Home Page:https://react-admin-pro.netlify.app/welcome

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nav toc title
title order
Docs
1
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

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
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
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.

MIT License

About

https://react-admin-pro.netlify.app/welcome


Languages

Language:TypeScript 90.2%Language:JavaScript 9.1%Language:EJS 0.3%Language:Less 0.3%Language:CSS 0.0%