https://github.com/remarkablemark/mui-template

MUI Template
https://github.com/remarkablemark/mui-template

jest material-ui mui react reactjs template typescript

Last synced: 19 days ago
JSON representation

MUI Template

• Host: GitHub
• URL: https://github.com/remarkablemark/mui-template
• Owner: remarkablemark
• License: mit
• Created: 2022-11-03T04:08:28.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T21:30:23.000Z (3 months ago)
• Last Synced: 2024-10-24T09:53:02.167Z (3 months ago)
• Topics: jest, material-ui, mui, react, reactjs, template, typescript
• Language: TypeScript
• Homepage: https://mui-template.pages.dev
• Size: 5.37 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mui-template

[![build](https://github.com/remarkablemark/mui-template/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/mui-template/actions/workflows/build.yml)

[![cypress](https://github.com/remarkablemark/mui-template/actions/workflows/cypress.yml/badge.svg)](https://github.com/remarkablemark/mui-template/actions/workflows/cypress.yml)

MUI Template.

This project is built with:

- [MUI](https://mui.com/)

- [Vite](https://vitejs.dev/)

- [Cloudflare Pages](https://pages.cloudflare.com/)

## Prerequisites

- [nvm](https://github.com/nvm-sh/nvm#readme)

## Install

Clone the repository:

```sh

git clone https://github.com/remarkablemark/mui-template.git

cd mui-template

```

Use the project's Node.js version:

```sh

nvm use

```

Install the dependencies:

```sh

npm install

```

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

### `npm run build`

Builds the app for production to the `dist` folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

### `npm run lint`

Runs ESLint.

### `npm test`

Runs Jest tests.

## License

[MIT](LICENSE)