Skip to content

Commit

Permalink
Initialize repo 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan Fitz committed Aug 26, 2019
0 parents commit d843b57
Show file tree
Hide file tree
Showing 10 changed files with 82 additions and 0 deletions.
Empty file added .gitignore
Empty file.
19 changes: 19 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Settings for Live SASS Compiler Extension (VS Code)
{
"liveSassCompile.settings.formats": [
{
"format": "expanded",
"extensionName": ".css",
"savePath": "/assets/styles"
}
],
"liveSassCompile.settings.excludeList": [
"**/node_modules/**",
".vscode/**"
],
"liveSassCompile.settings.generateMap": false,
"liveSassCompile.settings.autoprefix": [
"> 1%",
"last 2 versions"
]
}
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Web Boilerplate

This provides basic files and folders for a basic website using HTML, SASS, and JS.

Features include:
1. HTML Skeleton
2. Folders for images, JavaScript, and CSS
3. SASS partials already imported into styles.scss file
* `_setup.scss` partial for normalize.css, clearfix, border-box, and visuallyHidden
* Empty `_typography.scss` partial
* Empty `_variables.scss` partial

## Dependencies

This boilerplate uses the VS Code extension [Live Sass Compiler](https://marketplace.visualstudio.com/items?itemName=ritwickdey.live-sass) to compile `styles.scss` to a `styles.css` file.

## Instructions to use

Copy+paste the following lines of code into command line:

```
git clone https://github.com/danielfitz/webBoilerplate.git
read -p "Enter your repository name: " repoName && mv webBoilerplate $repoName && cd $repoName && rm -rf .git
```
Empty file added assets/images/.gitkeep
Empty file.
Empty file added assets/scripts/scripts.js
Empty file.
11 changes: 11 additions & 0 deletions assets/styles/partials/_setup.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// normalize.css
article,aside,details,figcaption,figure,footer,header,hgroup,nav,section,summary{display:block;}audio,canvas,video{display:inline-block;}audio:not([controls]){display:none;height:0;}[hidden]{display:none;}html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;}a:focus{outline:thin dotted;}a:active,a:hover{outline:0;}h1{font-size:2em;}abbr[title]{border-bottom:1px dotted;}b,strong{font-weight:700;}dfn{font-style:italic;}mark{background:#ff0;color:#000;}code,kbd,pre,samp{font-family:monospace, serif;font-size:1em;}pre{white-space:pre-wrap;word-wrap:break-word;}q{quotes:\201C \201D \2018 \2019;}small{font-size:80%;}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline;}sup{top:-.5em;}sub{bottom:-.25em;}img{border:0;}svg:not(:root){overflow:hidden;}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em;}button,input,select,textarea{font-family:inherit;font-size:100%;margin:0;}button,input{line-height:normal;}button,html input[type=button],/* 1 */input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;}button[disabled],input[disabled]{cursor:default;}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0;}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box;}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none;}textarea{overflow:auto;vertical-align:top;}table{border-collapse:collapse;border-spacing:0;}body,figure{margin:0;}legend,button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0;}

// clearfix class for parents of floated elements
.clearfix:after {visibility: hidden; display: block; font-size: 0; content: ''; clear: both; height: 0; }

// border-box
* { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }

// visuallyHidden class to remove items from view but keep them in screen reader
.visuallyHidden:not(:focus):not(:active) { position: absolute; width: 1px; height: 1px; margin: -1px;border: 0;padding: 0;white-space: nowrap;clip-path: inset(100%);clip: rect(00 0 0);overflow: hidden;}
1 change: 1 addition & 0 deletions assets/styles/partials/_typography.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// Insert typography-related styles here
1 change: 1 addition & 0 deletions assets/styles/partials/_variables.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// Insert variables here
6 changes: 6 additions & 0 deletions assets/styles/styles.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Required imports to prepare stylesheet
@import "partials/setup";
@import "partials/variables";

// Style imports for general styles
@import "partials/typography";
20 changes: 20 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>

<!-- CSS file -->
<link rel="stylesheet" href="assets/styles/styles.css" type="text/css">
</head>
<body>
<header></header>
<main></main>
<footer></footer>

<!-- JavaScript file -->
<script src="assets/scripts/scripts.js" type="text/javascript"></script>
</body>
</html>

0 comments on commit d843b57

Please sign in to comment.