material-domain
PageSpeed Insights: https://pagespeed.web.dev/report?url=durrani.dev&form_factor=desktop
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.1%) to scientific vocabulary
Keywords
Repository
PageSpeed Insights: https://pagespeed.web.dev/report?url=durrani.dev&form_factor=desktop
Basic Info
- Host: GitHub
- Owner: baharalidurrani
- License: gpl-3.0
- Language: TypeScript
- Default Branch: master
- Homepage: https://durrani.dev
- Size: 3.7 MB
Statistics
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
- Releases: 31
Topics
Metadata Files
README.md
React + ReduxTK + TypeScript + Vite + MUI
Digital Object Identifier available for citation at:
Features included
- Built using Typescript.
- Built using the official
redux-toolkittemplate. - All the dependencies in package.json are up-to-date.
- Redux folder structure is all set. Everything is decoupled upon store, slices, actions.
- Common, Type Definitions, Enums, Utils.
- Console Logs disabled in Prod Environment.
- Basic routing is integrated.
- Protected routes.
- Components are divided into Modules, Pages, Components, Molecule and Atom. (Modules being biggest and atom being smallest).
- Module Level Lazy Loading added.
- Material-UI (MUI) is integrated including fonts and icons.
- Basic Material Responsive Layout is added (Header/AppBar, SideNav/Drawer, MainContent).
- Centralized/Global MUI theme is added. (Almost zero CSS is used in the app).
- Auto/Manual Dark/Light theme is added.
To be added
- OpenAPI/Swagger Service Generator
- or axios interceptors.
- API Service unit tests.
Available Scripts
In the project directory, you can run:
yarn dev
Runs the app in the development mode securely with TLS.
Make sure you have mkCert configured properly.
Open 🔒https://localhost:5173 to view it in the browser.
yarn build
Builds the app for production to the dist folder.
It correctly bundles React 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!
See the section about deployment for more information.
yarn preview
Mimic static hosting from dist folder.
yarn serve
Clean Build and Preview. Handy for testing PWA features.
yarn dep:upgrade
Run to update all packages to their latest version.
yarn pretty
Run to format all files using prettier.
yarn lint
Run to Dry Lint all files.
yarn lint:fix
Run to fix all auto fixable eslint error.
Learn More
To learn React, check out the React documentation.
Owner
- Name: Bahar A. Dürrani
- Login: baharalidurrani
- Kind: user
- Location: Remote
- Company: @home-lending-pal
- Website: https://durrani.dev
- Repositories: 13
- Profile: https://github.com/baharalidurrani
A passionate Software Engineer whose dream is to work on a highly scaled application which is used by millions of users.
Citation (CITATION.cff)
abstract: 'A production-ready React, Typescript, MUI, Redux-Toolkit based responsive boilerplate.'
authors:
- family-names: Ali
given-names: Bahar
name-particle: Durrani
orcid: 'https://orcid.org/0000-0003-2750-4420'
cff-version: '1.1.0'
# date-released format YYYY-MM-DD
date-released: 2024-03-22
doi: '10.5281/zenodo.5600545'
keywords:
- react
- typescript
- mui
- mui
- redux
- 'redux-toolkit'
license: 'GPL-3.0'
message: 'If you use this software, please cite it using these metadata.'
repository-code: 'https://github.com/baharalidurrani/material-domain'
title: 'baharalidurrani/material-domain: v6.0.1'
# Please Update the date-released too 👆 (YYYY-MM-DD)
version: 'v6.0.1'
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: almost 2 years ago
All Time
- Total issues: 2
- Total pull requests: 58
- Average time to close issues: 20 days
- Average time to close pull requests: 21 days
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 0.5
- Average comments per pull request: 0.97
- Merged pull requests: 46
- Bot issues: 0
- Bot pull requests: 7
Past Year
- Issues: 0
- Pull requests: 11
- Average time to close issues: N/A
- Average time to close pull requests: 3 months
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.91
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 5
Top Authors
Issue Authors
- baharalidurrani (2)
Pull Request Authors
- baharalidurrani (52)
- dependabot[bot] (9)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- @types/node ^18.0.0 development
- @types/react ^18.0.14 development
- @types/react-dom ^18.0.5 development
- @types/react-redux ^7.1.24 development
- eslint-config-prettier ^8.5.0 development
- eslint-plugin-prettier ^4.0.0 development
- eslint-plugin-react ^7.30.0 development
- prettier ^2.7.1 development
- @emotion/react ^11.9.3
- @emotion/styled ^11.9.3
- @mui/icons-material ^5.8.4
- @mui/material ^5.8.4
- @reduxjs/toolkit ^1.8.2
- @testing-library/jest-dom ^5.16.4
- @testing-library/react ^13.3.0
- @testing-library/user-event ^14.2.1
- react ^18.2.0
- react-dom ^18.2.0
- react-redux ^8.0.2
- react-router-dom ^6.3.0
- react-scripts ^5.0.1
- tss-react ^3.7.0
- typescript ^4.7.4
- web-vitals ^2.1.4
- FirebaseExtended/action-hosting-deploy v0 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-node v2 composite
- FirebaseExtended/action-hosting-deploy v0 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-node v2 composite
- 590 dependencies