https://github.com/richienb/mdc-quickstart
An easy way to start using Material Design Components for the Web.
https://github.com/richienb/mdc-quickstart
mdc mdc-web quickstart
Last synced: 2 months ago
JSON representation
An easy way to start using Material Design Components for the Web.
- Host: GitHub
- URL: https://github.com/richienb/mdc-quickstart
- Owner: Richienb
- License: mit
- Created: 2018-10-15T07:28:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-14T05:19:54.000Z (almost 4 years ago)
- Last Synced: 2025-01-17T20:13:56.085Z (4 months ago)
- Topics: mdc, mdc-web, quickstart
- Language: JavaScript
- Homepage:
- Size: 185 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MDC Quickstart
An easy way to start using **Material Design Components for the Web**. This codebase is adapted from Google's [Getting Started](https://material.io/develop/web/docs/getting-started/) guide on the official Material Design website.
## How to start
There are three ways to start using the quickstart.
- Fork this repository
- [Download](https://github.com/Richienb/mdc-quickstart/archive/master.zip) this repository as a zip
- Clone this repository:
`git clone https://github.com/Richienb/mdc-quickstart.git`
## Installing the dependencies
This repository uses yarn as the package manager instead of the classic npm.
Yarn can be installed by running `npm install yarn --global`.
If you want to use npm instead, simply delete the `yarn.lock` file: `rm -f yarn.lock`.
To install the dependencies, run `yarn install`. If you're using npm, run `npm install`.
## Adding dependencies
To add dependencies with yarn, run `yarn add --dev` or with npm, `npm install --save-dev`.
## Removing dependencies
To remove dependencies with yarn, run `yarn remove ` or with npm, `npm uninstall `
## Starting the development server
To start the development server, run `npm start`. You will then be able to preview the website live at [127.0.0.1:8080](http://127.0.0.1:8080)
## Building the website
To build the website, run `npm run build`.