aichner / react-mdb-template

✨ This repository serves as an entry point for our future React MDB Basic projects.

Official React MDB Template

This repository serves as an entry point for future React MDB Basic projects of the Advertisement Agency Christian Aichner.

Report bug · Request feature

Table of contents

• Table of contents
• Quick start
• Bugs and feature requests
• Contributing
• Community
• Versioning
• Creators
• Thanks
• Copyright and license

Quick start

Several quick start options are available:

• Clone the repo: https://github.com/aichner/react-mdb-template.git

How to start this application?

• Use npm install to install all dependencies
• Start a local copy of the docs site with npm start
• Or build a local copy of the library with npm run build
• Your application will be running at localhost:3000

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Community

Get updates on our development and chat/talk with the project maintainers and community members.

• Follow @realaichner.
• Follow us on Facebook.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this repository is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Creators

Christian Aichner

🍁 Maintainer

Thanks

We do not have any external contributors yet, but if you want your name to be here, feel free to contribute to our project.

Copyright and license

SPDX-License-Identifier: (EUPL-1.2) Copyright © 2020 Werbeagentur Christian Aichner

react-mdb-template's Issues

Include Codacy badge

Describe the feature or change you'd like
Include the codacy code quality badge in the README.md

Remove package-lock

Is your feature request related to a problem? Please describe.
I'm always frustrated when my colleges clone my projects, use npm install and the package-lock file causes issues.

Describe the solution you'd like
Please add the package-lock.json to the .gitignore file.

Update MDB React

Describe the feature or change you'd like
Please update to ^4.19.1 of mdbreact.

Improve the code quality of the footer

Describe the feature or change you'd like
There is a code quality error regarding our max. char-length per line policy in the Footer. (Copyright)

There should be a type of change of option for adding documentation

Describe the feature or change you'd like
There should be an option to check for documentation only branches.

Fix Codacy issues

Is your feature request related to a problem? Please describe.
Currently our code is not as clean as it could be.

Describe the solution you'd like
Using Codacy we can check our repository for issues and resolve them manually.

Add VS Code config

Is your feature request related to a problem? Please describe.
Currently, the vscode configuration is not saved to GitHub

Describe the solution you'd like
The vscode GitHub configuration should be sent to GitHub

Add new generic elements

Is your feature request related to a problem? Please describe.
Currently, we need to add certain parts of code in every project.

Describe the solution you'd like
Some code should be added to the template to ease our development efforts.

A few things are:

• npm scripts vor predeploy and deploy for npm run deploy
• gh-pages as package
• Flat design buttons, new colors
• clickable class for cursor: pointer

Improve README

Is your feature request related to a problem? Please describe.
The current readme is not really expressive and does not provide any instructions.

Describe the solution you'd like
A new readme like in https://github.com/aichner/Company-Homepage should be added.

CSS Typo

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to _base.scss in src/utilities
2. Find ".darken-21"

Expected behavior
.darken-21 should be called .darken-2

Screenshots

Desktop (please complete the following information):

• OS: Windows 10 Professional 64-bit
• Browser: Chrome
• Version: 76.0.3809.87

Remove the html style attribute for <main> element

Describe the bug
Currently, the margin-top of the main element is set in HTML as style attribute. It is 4rem.

To Reproduce
Steps to reproduce the behavior:

1. Go to src/App.js
2. See <main> element

Expected behavior
The margin-top of the main element should be set in _base.scss and its value is expected to be 3rem.

Remove unnecessary code

Is your feature request related to a problem? Please describe.
Currently there is scrollToTop = () => window.scrollTo(0, 0); in the HomePage component.

Describe the solution you'd like
This line has no use and should be removed.

Update contrib and conflict files

Is your feature request related to a problem? Please describe.
The current code of conduct and contribution files are depreciated.

Describe the solution you'd like
Please update the two files.

Ref: https://github.com/aichner/Laravel-Template

Clean up the project

Describe the feature or change you'd like
There are a few parts of the code that require fixing. (Code Quality)

Fixing component pages folder- and file-structure

Describe the bug
Currently, components/pages does not share the common component structure of folders and a index.js exporting all folders.

To Reproduce
Steps to reproduce the behavior:

1. Go to src/components/pages
2. Compare with src/components/atoms

Expected behavior
HomePage.js and HomePage.scss should be moved to ./HomePage
./HomePage/HomePage.js should be renamed to ./HomePage/index.jsx
A index.js should be created
The index.js should import and export ./HomePage

Screenshots
Current structure:

Desired structure:

Desktop (please complete the following information):

• OS: Windows 10 Professional
• Browser Chrome
• Version 75.0.3770.142

Implemented SEMVER versioning

Describe the feature or change you'd like
Please introduce versions.
Ref: https://semver.org/