Skip to content

Commit

Permalink
update README and workflow yml
Browse files Browse the repository at this point in the history
  • Loading branch information
ProjectsByJackHe committed Dec 5, 2023
1 parent e2870f1 commit 0afba87
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 43 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/update-react.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
push:
branches:
- main
paths: [ "dashboard/**" ]
pull_request:
branches:
- main
paths: [ "dashboard/**" ]
52 changes: 9 additions & 43 deletions dashboard/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,12 @@
## Minimal [(Free version)](https://minimal-kit-react.vercel.app/)
## Quick Start

![license](https://img.shields.io/badge/license-MIT-blue.svg)
Make sure you install Node.js on your system.

> Free React Admin Dashboard made with Material-UI components and React.
- cd /dashboard
- npm i
- npm run dev (starts local server)

![preview](public/assets/preview.jpg)

## Demo

- [Dashboard Page](https://minimal-kit-react.vercel.app/)
- [Users Page](https://minimal-kit-react.vercel.app/user)
- [Products Page](https://minimal-kit-react.vercel.app/products)
- [Blog Page](https://minimal-kit-react.vercel.app/blog)
- [Login Page](https://minimal-kit-react.vercel.app/login)
- [Not Found Page](https://minimal-kit-react.vercel.app/404)

## Quick start

- [Download from Github](https://github.com/minimal-ui-kit/material-kit-react/archive/refs/heads/main.zip) or clone the repo : `git clone https://github.com/minimal-ui-kit/material-kit-react.git`
- Recommended `Node.js v18.x`.
- **Install:** `yarn install`
- **Start:** `yarn dev`
- **Build:** `yarn build`

## Upgrade to PRO Version

| Minimal Free | [Minimal Pro](https://material-ui.com/store/items/minimal-dashboard/) |
| :--------------- | :-------------------------------------------------------------------- |
| **6** Demo Pages | **70+** Demo Pages |
| - | Authentication with **Amplify**, **Auth0**, **JWT** and **Firebase** |
| - | [+More components](https://minimals.cc/components) |
| - | Dark & light mode |
| - | Next.js version |
| - | TypeScript version (Standard Plus and Extended license) |
| - | Design Figma File (Standard Plus and Extended license) |
| - | Complete Users Flows |
| - | Learn more: [Package & License](https://docs.minimals.cc/package) |

## License

Distributed under the MIT License. See [LICENSE](https://github.com/minimal-ui-kit/minimal.free/blob/main/LICENSE.md) for more information.

## Contact us

Email: [email protected]
## Building for production:
- npm run build
- This will automatically configure everything to assume the root url is `netperf/dist` instead of `/`, for the sake of Github Pages.
- A /dist folder will appear that contains the raw HTML, JS, CSS... etc.

0 comments on commit 0afba87

Please sign in to comment.