design-sparx / antd-multipurpose-dashboard

A free, open source, Vite, Typescript admin theme created using Ant Design 5
https://antd-multipurpose-dashboard.netlify.app/
MIT License
88 stars 23 forks source link
ant-design ant-design-charts antd react typescript vite

behance

logo

License GitHub issues open GitHub issues closed Live Demo Download Netlify Deployment Status Storybook Deployment Status
GitHub stars

Introduction

A professional Admin & Dashboard template based on Ant design 5 that comes with hundreds of UI components, forms, tables, charts, pages and icons. This template is built using React, Vite, Ant Design Charts, Ant Design Icons and Storybook.

Features

Tech stack

This project features all the latest tools and good practices in web development!

Framework

Design System and Animations

Charts

View more stacks #### Routing - [React router](https://reactrouter.com/en/main) #### Design Patterns - [ESLint](https://eslint.org/) - [Husky](https://github.com/typicode/husky) - [Lint staged](https://github.com/lint-staged/lint-staged) - [Prettier](https://prettier.io/) #### Components docs - [Storybook](https://storybook.js.org/) #### Date formatting - [moment](https://momentjs.com/) - [dayjs](https://day.js.org/) #### Utils - [lodash](https://lodash.com/) - [react-countup](https://github.com/glennreyes/react-countup)

Quick start

Download

Build tools

You'll need to install Node.js. Once Node.js is installed, run npm install to install the rest of the template's dependencies. All dependencies will be downloaded to the node_modules directory.

View commands ```bash copy npm install ``` Now you're ready to modify the source files and generate new files. To automatically detect file changes and start a local webserver at http://localhost:3000, run the following command. ```bash copy npm run dev ``` Compile, optimize, minify and uglify all source files to build/ ```bash copy npm run build ```

File structure

Inside the zip file you'll find the following directories and files. Both compiled and minified distribution files, as Inside the zip file, you'll find the following directories and files. Both compiled and minified distribution files and the source files are included in the package.

View file tree ```files πŸ“‚ antd-multi-dashboard/ ┣ πŸ“‚ .github/ # GitHub's folder configs ** ┣ πŸ“‚ .husky/ # Husky's folder ┃ ┣ πŸ“ƒ commit-msg # Commitlint git hook ┃ β”— πŸ“ƒ pre-commit # Lint-staged git hook ┣ πŸ“‚ .vscode/ # VSCode's workspace ** ┣ πŸ“‚ .idea/ # Intellij's webstorm workspace ** ┣ πŸ“‚ .storybook/ # Storybook folder config ** ┣ πŸ“‚ public/ # Public folder ┃ ┣ πŸ“‚ mocks/ # Mock data folder ** ┃ ┣ πŸ“‚ showcase/ # Showcase images folder ** ┃ ┣ πŸ“ƒ favicon.ico # Icon tab browser ┣ πŸ“‚ src/ ┃ ┣ πŸ“‚ assets/ # Assets folder ** ┃ ┣ πŸ“‚ components/ # App Components ** ┃ ┣ πŸ“‚ constants/ # App Components ** ┃ ┃ β”— πŸ“ƒ routes.tsx # All routes declarations ** ┃ ┣ πŸ“‚ context/ # React state conexts ** ┃ ┣ πŸ“‚ hooks/ # React Hooks ** ┃ ┃ β”— πŸ“ƒ useFetch.ts # Data fetch hook (optional) ** ┃ ┣ πŸ“‚ layouts/ # Page layouts folder ** ┃ ┣ πŸ“‚ pages/ # Pages ** ┃ ┣ πŸ“‚ routes/ # Routes config folder ** ┃ ┣ πŸ“‚ stories/ # Storybook folder ** ┃ ┣ πŸ“‚ types/ # Typescript types/interfaces ** ┃ ┣ πŸ“‚ utils/ # Useful functions folder ** ┣ πŸ“ƒ .editorconfig # Editor config ┣ πŸ“ƒ .eslintrc # ESLint config ┣ πŸ“ƒ .gitignore # Git ignore ┣ πŸ“ƒ .prettierignore # Prettier ignore ┣ πŸ“ƒ .prettierrc # Prettier ignore ┣ πŸ“ƒ .versionrc # Versioning config ┣ πŸ“ƒ .commitlintrc # Commitlint config ┣ πŸ“ƒ CHANGELOG.md # Changelogs ┣ πŸ“ƒ CONTRIBUTING.md # Contributing ┣ πŸ“ƒ LICENSE # License of the project ┣ πŸ“ƒ vite.config.js # Vite config ┣ πŸ“ƒ README.md # Main README ┣ πŸ“ƒ renovate.json # Renovate Bot config ** ┣ πŸ“ƒ tsconfig.json # TypeScript config ```