This repository has been archived by the owner. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upgraded to my H5BP project which includes all the latest libraries.
- Loading branch information
1 parent
c565a67
commit 32b23ca
Showing
93 changed files
with
4,341 additions
and
3,117 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Project Change-Log | ||
|
||
Below is a detailed change-log, along with specific tasks completed, for each | ||
version released to date. | ||
|
||
## Version 1.0.0 (12/09/2018) | ||
|
||
- [#enhancement](#enhancement) | ||
- Linked Respond.js in Responsive & Bootstrap templates. | ||
- Added plugins.js to all three theme variations. | ||
- Updated Espresso Generator files and settings. | ||
- Upgraded Bootstrap, H5BP and default templates to current versions. | ||
- Upgraded vendor scripts to: | ||
- Bootstrap 3.3.7 | ||
- jQuery 3.3.1 | ||
- Modernizr 3.6.0 | ||
- Respond 1.4.2 | ||
- html5shiv 3.7.3 | ||
- Upgraded HTML5 Boilerplate from version 4.3.0 to 6.1.0. | ||
- [#new](#new) | ||
- Added `MIT` License to project as per H5BP's license file. | ||
- New `README.md` with specific detail on how to get this operational along | ||
with other key, project-related information. | ||
- Added project files including, `.github` templates, `CHANGELOG.md`, | ||
`CODE_OF_CONDUCT.md` and `CONTRIBUTING.md`. | ||
|
||
## Version 0.0.1 (11/09/2018) | ||
|
||
- [#new](#new) | ||
- First Commit to the Repo. |
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,88 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
### Table of Contents | ||
|
||
- [Our Pledge](#our-pledge) | ||
- [Our Standards](#our-standards) | ||
- [Our Responsibilities](#our-responsibilities) | ||
- [Scope](#scope) | ||
- [Enforcement](#enforcement) | ||
- [Attribution](#attribution) | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, | ||
body size, disability, ethnicity, gender identity and expression, level of | ||
experience, nationality, personal appearance, race, religion, or sexual | ||
identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behaviour that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behaviour by participants include: | ||
|
||
- The use of sexualised language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behaviour and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behaviour. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviours that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an | ||
appointed representative at an online or offline event. Representation of a | ||
project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behaviour may be | ||
reported by contacting the project team [by clicking here][email]. The project | ||
team will review and investigate all complaints, and will respond in a way | ||
that it deems appropriate to the circumstances. The project team is obligated | ||
to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 1.4, available at | ||
[http://contributor-covenant.org/version/1/4][version]. | ||
|
||
[//]: # (Make sure to change the email address below to your) | ||
[//]: # (project-specific email.) | ||
|
||
[email]: mailto:[email protected]?subject=Contributor+Covenant+Code+of+Conduct | ||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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,34 @@ | ||
# How to Contribute to This Project | ||
|
||
## Did You Find a Bug? | ||
|
||
- **Ensure the bug was not already reported** by searching on GitHub | ||
under [Issues][issues]. | ||
- If you're unable to find an open issue addressing the problem, | ||
[open a new one][new-issue]. Be sure to include a **title and clear | ||
description**, as much relevant information as possible, and a **code | ||
sample** or an **executable test case** demonstrating the expected | ||
behaviour that is not occurring. | ||
|
||
## Did You Write a Patch That Fixes a Bug? | ||
|
||
- Open a new GitHub pull request with the patch. | ||
- Fork this project | ||
- Create your feature branch: `git checkout -b my-new-feature` | ||
- Commit your changes: `git commit -am 'Add some feature'` | ||
- Push to the branch: `git push origin my-new-feature` | ||
- Submit a pull request :tada: | ||
- Ensure the PR description clearly describes the problem and solution. | ||
Include the relevant issue number if applicable. | ||
|
||
## Do You Intend to Add a New Feature or Change an Existing One? | ||
|
||
- Suggest your change as a [new issue][new-issue] using the label | ||
`enhancement`, **BEFORE** you start writing code. | ||
|
||
Thanks for contributing! :heart: | ||
|
||
[//]: # (Change the URL's below to your own project information) | ||
|
||
[issues]: https://github.com/justinhartman/H5BP.espressotemplate/issues | ||
[new-issue]: https://github.com/justinhartman/H5BP.espressotemplate/issues/new/choose |
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,22 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Justin Hartman | ||
Copyright (c) HTML5 Boilerplate | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,178 @@ | ||
# HTML5 Boilerplate Template for Espresso | ||
|
||
The un-official H5BP website boilerplate template for Espresso (espressoapp.com) | ||
, the macOS Editor App. | ||
|
||
**_[Espresso][espressoapp] are the original authors of this template, I have | ||
simply taken what they have provided in the application already and upgraded it | ||
to use all of the latest projects. I found the bundled version was too outdated | ||
and needed upgrading/maintaining._** | ||
|
||
###### Table of Contents | ||
|
||
- [What is Included](#what-is-included) | ||
- [Vendor Scripts](#vendor-scripts) | ||
- [Theme Templates](#theme-templates) | ||
- [Theme Options](#theme-options) | ||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installing](#installing) | ||
- [In Espresso](#in-espresso) | ||
- [Via Terminal](#via-terminal) | ||
- [Contributing](#contributing) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Versioning](#versioning) | ||
- [Change-Log](#change-log) | ||
- [Authors](#authors) | ||
- [License](#license) | ||
- [Acknowledgements](#acknowledgements) | ||
|
||
## What is Included | ||
|
||
The following come included in this template for `Espresso`. | ||
|
||
### Vendor Scripts | ||
|
||
The following vendor scripts are included in the template and have all been | ||
upgraded from their original versions. | ||
|
||
1. [Bootstrap 3.3.7][bootstrap] - from version 3.1.1 | ||
2. [jQuery 3.3.1][jquery] - from version 1.11.0 | ||
3. [Modernizr 3.6.0][modernizr] - from version 2.6.2 | ||
4. [Respond.js 1.4.2][respond] - from version 1.1.0 | ||
5. [html5shiv 3.7.3][html5shiv] - from version 3.6 | ||
|
||
### Theme Templates | ||
|
||
H5BP website boilerplate template for Espresso has also been upgrade from | ||
version 4.6.0 to version 6.1.0. The template includes the following three | ||
variations: | ||
|
||
1. Blank HTML5 starter template with only jQuery included. | ||
2. Responsive starter template with jQuery and Respond.js. | ||
3. Bootstrap Jumbotron template with jQuery and Respond.js. | ||
|
||
You have the choice of either `Modernizr` or `html5shiv` as the HTML5 fallback | ||
with each of the three options above. | ||
|
||
### Theme Options | ||
|
||
The following screenshot outlines the various options available to you when you | ||
create a _New Project_ within `Espresso`. | ||
|
||
![Theme Options](docs/images/theme-options.png) | ||
|
||
## Getting Started | ||
|
||
These instructions will get the H5BP template installed on your macOS machine. | ||
|
||
### Prerequisites | ||
|
||
You will need a copy of [Espresso][espressoapp] running on `macOS`. | ||
|
||
### Installing | ||
|
||
There are two methods to installing this template and these are documented | ||
below. | ||
|
||
#### In Espresso | ||
|
||
- Download the template by [clicking this link][code]. | ||
- Extract the zip folder. | ||
- Open up your `Espresso.app` application on your machine. | ||
- Click `File` -> `New Project` | ||
(or <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>N</kbd>) | ||
- Click `Show Templates Folder` | ||
|
||
![show-templates-folder](docs/images/show-templates-folder.png) | ||
|
||
- Copy the extracted folder (called `H5BP.espressotemplate`) to the `Templates` | ||
directory that has just opened up. | ||
|
||
![templates-folder](docs/images/templates-folder.png) | ||
|
||
The new template should now be available for you to use in the `Espresso` app: | ||
|
||
![new template](docs/images/new-template.png) | ||
|
||
#### Via Terminal | ||
|
||
- Open up your `Terminal.app` application on your machine. | ||
- Run the following commands to checkout the project directly to your | ||
`Templates` folder: | ||
|
||
```terminal | ||
$ cd ~/Library/Application\ Support/Espresso/Templates/ | ||
$ git clone https://github.com/justinhartman/H5BP.espressotemplate.git | ||
``` | ||
|
||
You can now open up `Espresso.app` and the template will be available to you | ||
when you click on `New Project`. | ||
|
||
![new template](docs/images/new-template.png) | ||
|
||
## Contributing | ||
|
||
Please read the [CONTRIBUTING.md][CONTRIBUTING] file for details on how you | ||
can get involved in the project as well as the process for submitting bugs | ||
and pull requests. | ||
|
||
## Code of Conduct | ||
|
||
Please read the [CODE_OF_CONDUCT.md][COC] file for the guidelines that govern | ||
the community. | ||
|
||
## Versioning | ||
|
||
We use [Semantic Versioning][semver] for software versions of this project. | ||
For a list of all the versions available, see the [tags][tags] and | ||
[releases][releases] on this repository. | ||
|
||
## Change-Log | ||
|
||
View the [CHANGELOG.md][changelog] file for a detailed list of changes, | ||
along with specific tasks completed for each version released to date. | ||
|
||
## Authors | ||
|
||
- Justin Hartman - [@justinhartman][author-1] | ||
|
||
Also see the list of [contributors][contribs] who have participated in this | ||
project. | ||
|
||
## License | ||
|
||
This project is licensed under the `MIT` License. See the | ||
[LICENSE][license] file for full details. | ||
|
||
## Acknowledgements | ||
|
||
Special thanks go out to the following people and projects. | ||
|
||
- [Espresso][espressoapp] - for the included template that this has been | ||
upgraded from. | ||
- [HTML5Boilerplate][h5bp] - for providing the boilerplates in this template. | ||
- [@justinhartman/.github][.github] - for the Github project templates. | ||
|
||
[//]: # (Make sure to change the URL links for `[tags]`, `[releases]`,) | ||
[//]: # (`[contribs]` and `[author-1]` below to your specific project.) | ||
|
||
[deploy]: #deployment | ||
[CONTRIBUTING]: CONTRIBUTING.md | ||
[COC]: CODE_OF_CONDUCT.md | ||
[license]: LICENSE | ||
[changelog]: CHANGELOG.md | ||
[semver]: http://semver.org | ||
[tags]: https://github.com/justinhartman/H5BP.espressotemplate/tags | ||
[releases]: https://github.com/justinhartman/H5BP.espressotemplate/releases | ||
[contribs]: https://github.com/justinhartman/H5BP.espressotemplate/contributors | ||
[author-1]: https://github.com/justinhartman | ||
[.github]: https://github.com/justinhartman/.github | ||
[espressoapp]: https://espressoapp.com "Espresso, the Mac Editor." | ||
[code]: https://github.com/justinhartman/H5BP.espressotemplate/archive/master.zip | ||
[h5bp]: https://html5boilerplate.com | ||
[bootstrap]: https://getbootstrap.com/docs/3.3/ | ||
[jquery]: https://jquery.com | ||
[modernizr]: https://modernizr.com | ||
[respond]: https://github.com/scottjehl/Respond | ||
[html5shiv]: https://github.com/aFarkas/html5shiv |
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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"name": "HTML5 Boilerplate", | ||
"description": "The official H5BP website boilerplate.", | ||
"name": "Bootstrap 4 Boilerplate Kit", | ||
"description": "A Boilerplate Kit for Bootstrap to get your projects up and running using the latest Bootstrap 4.1.3 framework.", | ||
"context": "*" | ||
} |
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
Oops, something went wrong.