Skip to content

Commit

Permalink
Update Material UI Kit and Fix Authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
xeroxis-xs committed May 28, 2024
1 parent 7883cd2 commit e16c295
Show file tree
Hide file tree
Showing 209 changed files with 21,632 additions and 8,302 deletions.
693 changes: 4 additions & 689 deletions .editorconfig

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
const { resolve } = require('node:path');

const project = resolve(__dirname, 'tsconfig.json');

module.exports = {
root: true,
extends: [
require.resolve('@vercel/style-guide/eslint/node'),
require.resolve('@vercel/style-guide/eslint/typescript'),
require.resolve('@vercel/style-guide/eslint/browser'),
require.resolve('@vercel/style-guide/eslint/react'),
require.resolve('@vercel/style-guide/eslint/next'),
],
parserOptions: {
project,
},
settings: {
'import/resolver': {
typescript: {
project,
},
},
},
rules: {
'@typescript-eslint/no-unused-vars': [
'error',
{
ignoreRestSiblings: true,
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^_',
},
],
'@typescript-eslint/no-empty-interface': [
'error',
{
allowSingleExtends: true,
},
],
'@typescript-eslint/no-shadow': [
'error',
{
ignoreOnInitialization: true,
},
],
'import/newline-after-import': 'error',
'react/jsx-uses-react': 'error',
'react/react-in-jsx-scope': 'error',
'unicorn/filename-case': [
'error',
{
cases: {
kebabCase: true, // personal style
pascalCase: true,
},
},
],

// Deactivated
'@typescript-eslint/dot-notation': 'off', // paths are used with a dot notation
'@typescript-eslint/no-misused-promises': 'off', // onClick with async fails
'@typescript-eslint/no-non-null-assertion': 'off', // sometimes compiler is unable to detect
'@typescript-eslint/no-unnecessary-condition': 'off', // remove when no static data is used
'@typescript-eslint/require-await': 'off', // Server Actions require async flag always
'@typescript-eslint/prefer-nullish-coalescing': 'off', // personal style
'import/no-default-export': 'off', // Next.js components must be exported as default
'import/no-extraneous-dependencies': 'off', // conflict with sort-imports plugin
'import/order': 'off', // using custom sort plugin
'no-nested-ternary': 'off', // personal style
'no-redeclare': 'off', // conflict with TypeScript function overloads
'react/jsx-fragments': 'off', // personal style
'react/prop-types': 'off', // TypeScript is used for type checking

'@next/next/no-img-element': 'off', // Temporary disabled
},
};
14 changes: 0 additions & 14 deletions .eslintrc.json

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ out
/.env.development.local
/.env.test.local
/.env.production.local
.env

npm-debug.log*
yarn-debug.log*
Expand Down
24 changes: 21 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
## v3.0.0
# Changelog

###### Feb 24, 2023
## v4.0.0

###### Mar 8, 2024

- Add `TypeScript`
- Refactor code
- Replace `date-fns` with `dayjs`
- Replace `Formik` with `React Hook Form`
- Replace `Hero Icons` with `Phosphor Icons`
- Replace `pages` router with `app router`
- Replace `Yup` with `Zod`
- Update `eslint` rules
- Update auth implementation
- Update dependencies
- Update design system

## v3.0.0

###### Feb 24, 2023

- Refactor components
- Replace authentication
- Update dependencies
- Update design system

## v2.1.0

Expand All @@ -31,8 +49,8 @@
- Add `Feather Icons`
- Add `Formik` for login/register pages
- Implement `react-router` v6 routing method
- Remove extra views
- Remove `node-sass` dependency
- Remove extra views
- Update all components to match the PRO version style
- Update dependencies
- Update folder structure to remove folder depth
Expand Down
114 changes: 67 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,90 @@
# Getting Started with Create React App
## [Devias Kit - React](https://material-kit-react.devias.io/)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
![license](https://img.shields.io/badge/license-MIT-blue.svg)

## Available Scripts
[![Devias Kit - React](https://github.com/devias-io/material-kit-react/blob/main/public/assets/thumbnail.png)](https://material-kit-react.devias.io/)

In the project directory, you can run:
> Free React Admin Dashboard made with [MUI's](https://mui.com) components, [React](https://reactjs.org) and of course [Next.js](https://github.com/vercel/next.js) to boost your app development process!
### `npm start`
## Pages

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
- [Dashboard](https://material-kit-react.devias.io)
- [Customers](https://material-kit-react.devias.io/dashboard/customers)
- [Integrations](https://material-kit-react.devias.io/dashboard/integrations)
- [Settings](https://material-kit-react.devias.io/dashboard/settings)
- [Account](https://material-kit-react.devias.io/dashboard/account)
- [Sign In](https://material-kit-react.devias.io/auth/sign-in)
- [Sign Up](https://material-kit-react.devias.io/auth/sign-up)
- [Reset Password](https://material-kit-react.devias.io/auth/reset-password)

The page will reload when you make changes.\
You may also see any lint errors in the console.
## Free Figma Community File

### `npm test`
- [Duplicate File](https://www.figma.com/file/b3L1Np4RYiicZAOMopHNkm/Devias-Dashboard-Design-Library-Kit)

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
## Upgrade to PRO Version

### `npm run build`
We also have a pro version of this product which bundles even more pages and components if you want
to save more time and design efforts :)

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
| Free Version (this one) | [Devias Kit Pro](https://mui.com/store/items/devias-kit-pro/) |
| ------------------------ | :--------------------------------------------------------------------------- |
| **8** Pages | **80+** Pages |
| ✔ Custom Authentication | ✔ Authentication with **Amplify**, **Auth0**, **Firebase** and **Supabase** |
| - | ✔ Vite Version |
| - | ✔ Dark Mode Support |
| - | ✔ Complete Users Flows |
| - | ✔ Premium Technical Support |

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
## Quick start

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
- Clone the repo: `git clone https://github.com/devias-io/material-kit-react.git`
- Make sure your Node.js and npm versions are up to date
- Install dependencies: `npm install` or `yarn`
- Start the server: `npm run dev` or `yarn dev`
- Open browser: `http://localhost:3000`

### `npm run eject`
## File Structure

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
Within the download you'll find the following directories and files:

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
```
┌── .editorconfig
├── .eslintrc.js
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── next-env.d.ts
├── next.config.js
├── package.json
├── README.md
├── tsconfig.json
├── public
└── src
├── components
├── contexts
├── hooks
├── lib
├── styles
├── types
└── app
├── layout.tsx
├── page.tsx
├── auth
└── dashboard
```

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
## Resources

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
- More freebies like this one: https://devias.io

## Learn More
## Reporting Issues:

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
- [Github Issues Page](https://github.com/devias-io/material-kit-react/issues)

To learn React, check out the [React documentation](https://reactjs.org/).
## License

### Code Splitting
- Licensed under [MIT](https://github.com/devias-io/material-kit-react/blob/main/LICENSE.md)

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
## Contact Us

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
- Email Us: [email protected]
5 changes: 0 additions & 5 deletions jsconfig.json

This file was deleted.

5 changes: 5 additions & 0 deletions next-env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
3 changes: 0 additions & 3 deletions next.config.js

This file was deleted.

4 changes: 4 additions & 0 deletions next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** @type {import('next').NextConfig} */
const config = {};

export default config;
Loading

0 comments on commit e16c295

Please sign in to comment.