Skip to content

Commit

Permalink
Merge pull request #19 from creativetimofficial/dev-main
Browse files Browse the repository at this point in the history
Dev main
  • Loading branch information
sajadevo committed Jun 3, 2021
2 parents 6bb9d9a + 5ec7858 commit 78adb63
Show file tree
Hide file tree
Showing 3 changed files with 179 additions and 2 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Change Log

## [1.0.0] 2021-06-04

### Original Release

- Started project from [Material Tailwind Kit React](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=changelog-mtkr)
- Updated all dependencies from [Material Tailwind Kit React](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=changelog-mtkr) and those dependencies that were not working with the new React v17+ API, were deleted and/or replaced

### Warning

_Warnings might appear while doing a clean npm install - they do not affect the UI or the functionality of the product, and they appear because of NodeJS and not from the product itself._
_This product was designed and developed using NodeJS version 14.16.0 LTS, so please make sure to have a compatible version of NodeJS._
151 changes: 149 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,149 @@
# material-tailwind-kit-react
Free and Open Source UI Kit for Tailwind CSS and React based on Google's Material Design.
# [Material Tailwind Kit React](https://demos.creative-tim.com/material-tailwind-kit-react/#/?ref=readme-mtkr)

![version](https://img.shields.io/badge/version-1.0.0-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/material-tailwind-kit-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-tailwind-kit-react/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/material-tailwind-kit-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-tailwind-kit-react/issues?q=is%3Aissue+is%3Aclosed)

![Image](https://s3.amazonaws.com/creativetim_bucket/products/486/original/opt_mtrk_thumbnail.jpg?1622709620)

Material Tailwind Kit React is a free and open-source UI Kit based on two popular front-end technologies: Tailwind CSS & React. It was built to simplify the developer's work in the quest of creating intuitive interfaces.

Material Tailwind has 4 pre-built example pages. From landing pages to profile, login and register, you will be able to set up the basic structure for your web project quickly.

## Table of Contents

- [Versions](#versions)
- [Demo](#demo)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [File Structure](#file-structure)
- [Browser Support](#browser-support)
- [Resources](#resources)
- [Reporting Issues](#reporting-issues)
- [Technical Support or Questions](#technical-support-or-questions)
- [Licensing](#licensing)
- [Useful Links](#useful-links)

## Versions

[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/react.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=readme-mtkr)
| React |
| ----- |

| [![Material Tailwind Kit React](https://s3.amazonaws.com/creativetim_bucket/products/486/original/opt_mtrk_thumbnail.jpg?1622709620)](https://demos.creative-tim.com/material-tailwind-kit-react/#/?ref=readme-mtkr)

## Demo

- [Landing page](https://demos.creative-tim.com/material-tailwind-kit-react/#/landing?ref=readme-mtkr)
- [Profile page](https://demos.creative-tim.com/material-tailwind-kit-react/#/profile?ref=readme-mtkr)
- [Login page](https://demos.creative-tim.com/material-tailwind-kit-react/#/login?ref=readme-mtkr)
- [Register page](https://demos.creative-tim.com/material-tailwind-kit-react/#/register?ref=readme-mtkr)

## Quick start

Quick start options:

- Download from [Creative Tim](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=readme-mtkr).

## Terminal Commands

1. Download and Install NodeJs from [NodeJs Official Page](https://nodejs.org/en/download/).
2. Navigate to the root / directory and run npm install or (yarn install, if you're using yarn) to install our local dependencies.

## Documentation

Material Tailwind Kit React build using Material Tailwind and the documentation of Material Tailwind is hosted at [Material Tailwinl](https://material-tailwind.com/documentation/quick-start?ref=readme-mtkr).

### What's included

Within the download you'll find the following directories and files:

```
Material Tailwind Kit React
├── material-tailwind-kit-react
│ ├── public
│ │   ├── index.html
│ │   ├── favicon.ico
│ │   └── apple-icon.png
│ ├── src
│ │   ├── assets
│ │   │ ├── img/
│ │   │ └── styles/
│ │   ├── components
│ │   │ ├── landing/
│ │   │ ├── login/
│ │   │ ├── profile/
│ │   │ ├── DefaultFooter.js
│ │   │ ├── DefaultNavbar.js
│ │   │ └── SimpleFooter.js
│ │ ├── Pages
│ │ │   ├── Landing.js
│ │ │   ├── Login.js
│ │ │   ├── Profile.js
│ │ │   └── Register.js
│ │ ├── App.js
│ │ ├── App.test.js
│ │ ├── index.js
│ │ ├── reportWebVitals.js
│ │ └── setup.test.js
│ ├── CHANGELOG.md
│ ├── jsconfig.json
│ ├── LICENSE
│ ├── package.json
│ ├── postcss.config.js
│ ├── README.md
│ ├── tailwind.config.js
│ ├── yarn.lock
```

## Browser Support

At present, we officially aim to support the last two versions of the following browsers:

<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">

## Resources

- [Live Preview](https://demos.creative-tim.com/material-tailwind-kit-react/#/?ref=readme-mtkr)
- [Download Page](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=readme-mtkr)
- Documentation is [here](https://material-tailwind.com/documentation/quick-start?ref=readme-mtkr)
- [License Agreement](https://www.creative-tim.com/license?ref=readme-mtkr)
- [Support](https://www.creative-tim.com/contact-us?ref=readme-mtkr)
- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-tailwind-kit-react/issues)

## Reporting Issues

We use GitHub Issues as the official bug tracker for the Material Tailwind Kit React. Here are some advices for our users that want to report an issue:

1. Make sure that you are using the latest version of the Material Tailwind Kit React. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/product/material-tailwind-kit-react?ref=readme-mtkr).
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

## Technical Support or Questions

If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us?ref=readme-mtkr) instead of opening an issue.

## Licensing

- Copyright 2021 [Creative Tim](https://www.creative-tim.com?ref=readme-mtkr)
- Creative Tim [license](https://www.creative-tim.com/license?ref=readme-mtkr)

## Useful Links

- [More products](https://www.creative-tim.com/templates?ref=readme-mtkr) from Creative Tim

- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)

- [Freebies](https://www.creative-tim.com/templates/free?ref=readme-mtkr) from Creative Tim

- [Affiliate Program](https://www.creative-tim.com/affiliates/new?ref=readme-mtkr) (earn money)

##### Social Media

Twitter: <https://twitter.com/CreativeTim>

Facebook: <https://www.facebook.com/CreativeTim>

Dribbble: <https://dribbble.com/creativetim>

Google+: <https://plus.google.com/+CreativetimPage>

Instagram: <https://instagram.com/creativetimofficial>
17 changes: 17 additions & 0 deletions src/assets/styles/index.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
/*!
=========================================================
* Argon Dashboard - v1.1.0
=========================================================
* Product Page: https://www.creative-tim.com/product/argon-dashboard
* Copyright 2019 Creative Tim (https://www.creative-tim.com)
* Licensed under MIT (https://github.com/creativetimofficial/argon-dashboard/blob/master/LICENSE.md)
* Coded by Creative Tim
=========================================================
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*/
@import 'tailwindcss/base';
@import 'tailwindcss/components';
@import 'tailwindcss/utilities';
Expand Down

0 comments on commit 78adb63

Please sign in to comment.