This repository serves as a template for creating a dashboard application using React.js and MUI Toolpad. It leverages Vite for build tooling and TypeScript for type safety.
- React 18: Utilizes the latest features of React.
- TypeScript: Ensures type safety throughout the application.
- Vite: Provides fast build times and a lean development experience.
- MUI Toolpad: Integrates MUI's Toolpad Core components for building internal tools and dashboards. citeturn0search0
Ensure you have the following installed:
-
Clone the repository:
git clone https://github.com/akshaypx/react-toolpad-starter.git
-
Navigate to the project directory:
cd react-toolpad-starter -
Install dependencies:
Using npm:
npm install
Or using Yarn:
yarn install
To start the development server:
Using npm:
npm run devOr using Yarn:
yarn devThe application will be running at http://localhost:3000 by default.
To start a new project based on this template without copying the original Git history, you can use degit:
npx degit akshaypx/react-toolpad-starter my-new-app
cd my-new-app
git init
git remote add origin https://github.com/your-username/my-new-app.git
git add .
git commit -m "Initial commit from react-toolpad-starter"
git push -u origin mainThis clones the code into a fresh folder, initializes your own Git repo, and sets it up to push to your GitHub.
src/: Contains the source code of the application.main.tsx: Entry point of the application.App.tsx: Main application component.
public/: Contains static assets.index.html: Main HTML file.
This template is set up to utilize MUI Toolpad Core components, which offer a suite of React components designed for building internal tools and dashboards. For detailed documentation on using these components, refer to the Toolpad Core documentation.
npm run devoryarn dev: Starts the development server.npm run buildoryarn build: Builds the application for production.npm run lintoryarn lint: Runs ESLint to analyze code for potential errors.
Contributions are welcome! Please fork the repository and submit a pull request with your changes.
This project is licensed under the MIT License.