-
Notifications
You must be signed in to change notification settings - Fork 356
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
336 changed files
with
11,029 additions
and
10,219 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Quickstart Repo | ||
|
||
Start using the Covalent Quickstart | ||
|
||
Create a new repo based on the covalent-quickstart | ||
|
||
Clone the [covalent-quickstart](https://github.com/Teradata/covalent-quickstart) into a new project folder (e.g. my-product) | ||
|
||
## Clone the repo | ||
|
||
```bash | ||
git clone https://github.com/Teradata/covalent-quickstart.git my-product | ||
cd my-product | ||
``` | ||
|
||
Remove the git directory to start clean | ||
|
||
```bash | ||
rm -rf .git | ||
``` | ||
|
||
## Create a new Git repository for your product | ||
|
||
You could start writing code now and throw it all away when you're done. If you'd rather preserve your work under source control, consider taking the following steps. | ||
|
||
Initialize this project as a local git repo and make the first commit: | ||
|
||
```bash | ||
git init | ||
git add . | ||
git commit -m "Initial commit" | ||
``` | ||
|
||
Create a remote repository for this project on the service of your choice. | ||
|
||
```bash | ||
git remote add origin | ||
git push -u origin master | ||
``` | ||
|
||
## Start Developing! | ||
|
||
Prerequisites | ||
|
||
- Node 6.11.1+ | ||
- NPM 3+ | ||
- Angular CLI | ||
- Protractor (for testing) | ||
- TSLint (for code style) | ||
|
||
If you don't have the Angular CLI, install: | ||
|
||
```bash | ||
npm i -g @angular/cli@latest | ||
``` | ||
|
||
Install Typescript: | ||
|
||
```bash | ||
npm install -g typescript | ||
``` | ||
|
||
To install Protractor & TSLint for testing: | ||
|
||
```bash | ||
npm install -g protractor | ||
npm install -g tslint | ||
``` | ||
|
||
Then update the webdriver manager: | ||
|
||
```bash | ||
webdriver-manager update | ||
``` | ||
|
||
Install Node packages: | ||
|
||
```bash | ||
npm i | ||
``` | ||
|
||
Run the Angular-CLI local server: | ||
|
||
```bash | ||
ng serve | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
## Utility SASS Mixins | ||
|
||
You can cherry pick the `utility` classes that fit your needs with our `scss` mixins instead of including everything with the `platform.css`. | ||
|
||
After adding the `all-theme.scss`, the mixins will be available for usage: | ||
|
||
```css | ||
@import '~@covalent/core/theming/all-theme'; | ||
``` | ||
|
||
### Core Styles Mixin | ||
|
||
Covalent includes out of the box some styles to make your application look better, this can be used by adding the following: | ||
|
||
```css | ||
// Include the core styles for Covalent | ||
@include covalent-core(); | ||
``` | ||
|
||
We also bundle the material icons | ||
|
||
```css | ||
// Include pre-bundled material-icons | ||
$mat-font-url: '../node_modules/@covalent/core/common/styles/font/'; | ||
@include covalent-material-icons(); | ||
// Alternative way to include material-icons | ||
// @import '../node_modules/@covalent/core/common/material-icons.css'; | ||
``` | ||
|
||
### Covalent Utilities Mixin | ||
|
||
To include [utility classes](https://teradata.github.io/covalent/#/style-guide/utility-styles), add the following: | ||
|
||
```css | ||
// Include covalent utility classes | ||
@include covalent-utilities(); | ||
``` | ||
|
||
### Flex Layout Mixin | ||
|
||
To include [flex layout v1](https://teradata.github.io/covalent/#/layouts), add the following: | ||
|
||
```css | ||
// Include flex layout classes | ||
@include covalent-layout(); | ||
``` | ||
|
||
### Colors Mixin | ||
|
||
To include the [color classes](https://teradata.github.io/covalent/#/style-guide/colors), add the following: | ||
|
||
```css | ||
// Include covalent color classes | ||
@include covalent-colors(); | ||
``` | ||
|
||
### Typography Mixin | ||
|
||
To include the [typography classes](https://teradata.github.io/covalent/#/style-guide/typography), add the following: | ||
|
||
```css | ||
// Include covalent typography classes | ||
@include covalent-typography(); | ||
``` | ||
|
||
### Example including every single mixin | ||
|
||
If you want to include everything, include the following snippet (or just include the `platform.css` as described in the [getting started](http://localhost:4200/#/docs) docs) | ||
|
||
```css | ||
@import '~@covalent/core/theming/all-theme'; | ||
|
||
// Include the core styles for Covalent | ||
@include covalent-core(); | ||
|
||
// Include pre-bundled material-icons | ||
$mat-font-url: '../node_modules/@covalent/core/common/styles/font/'; | ||
@include covalent-material-icons(); | ||
// Alternative way to include material-icons | ||
// @import '../node_modules/@covalent/core/common/material-icons.css'; | ||
|
||
// Include covalent utility classes | ||
@include covalent-utilities(); | ||
|
||
// Include flex layout classes | ||
@include covalent-layout(); | ||
|
||
// Include covalent typography classes | ||
@include covalent-typography(); | ||
|
||
// Include covalent color classes | ||
@include covalent-colors(); | ||
``` | ||
|
Oops, something went wrong.