Mui-dash

A custom Material-UI Dashboard template

Mui-dash is a Next.js app that features multi-lingual support, Typescript, and Sass.

Table Of Contents
Features
Quick Start
Problem solving
Project code sumary
Connect with me
License
Contributions and issues

Features

🌎 Implements Next's Internationalized Routing for multi-language support.
Currently supported locales include (see figures below):
- English to Spanish figure 1.
- French to Hindi figure 2.
- Chinese back to English figure 3.
- English (en) - figure 4.
- Spanish (es) - figure 5.
- French (fr) - figure 6.
- Hindi (hi) - figure 7.
- Chinese (simplified) (zh) - figure 8.
🌐 The 3rd-party package next-translate was used to simplify each locales import - next-translate's repository
✅ Built from Material-UI's Dashboard Template. The source code and the live sample site can be found here.

English and Spanish - figure 1.

French and Hindi - figure 2.

Chinese and back to English - figure 3.

English, en - figure 4.

Spanish, es - figure 5.

French, fr - figure 6.

Hindi, hi - figure 7.

Chinese (simplified), zh - figure 8.

Quick Start

1. Clone repository

git clone https://github.com/Brlaney/mui-dash.git

2. Install dependencies

cd mui-dash

# then for yarn users:
yarn install

# or npm users:
npm i

3. Ready for development

yarn dev

#or

npm run dev

Now navigate to http://localhost:3000/ and check it out.

Problem solving

In this section I will sumarize my problem solving process for any issues that arose while creating this project. Issues, bugs, errors, etc. yield critical points in any project were you are presented with the opportunity to evolve your web development skills - after all, Engineering at its core is problem solving.

Project code summary

Date updated: 09-30-2021
First commit: 08-20-2021
Directory: \mui-dash\src
Totals:
- 30 files
- 2554 lines of code
- 2 comments
- 107 blanks
- Sum total 2,663 lines

Languages

language	files	code	comment	blank	total
TypeScript	16	1,806	0	28	1,834
TypeScript React	11	674	2	64	740
SCSS	3	74	0	15	89

Directories

path	files	code	comment	blank	total
src/	30	2,554	2	107	2,663
src/components	8	493	1	39	533
src/lib	16	1,806	0	28	1,834
src/pages	3	181	1	25	207
src/scss	3	74	0	15	89

Connect with me

Email: brlaney@outlook.com
Twitter: brendan_webdev
Instagram: brlaney94

License

This repository was built on Material-UI's official Dashboard template. All of their templates can be found here. I am not the original author of the template this project was built on-top of. I have added features, re-structured components, and added my own code to the aforementioned template in order to better fit my needs.

MIT License

Copyright (c) 2021

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contributions and issues

I would love your feedback on my project - please feel free to make a pull request or submit an issue if you find any. Thanks for checking out my project!

Brlaney/mui-dash