Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fboes/broilerplate
A plattform-agnostic web-project boilerplate with SASS & JS.
https://github.com/fboes/broilerplate
Last synced: about 1 month ago
JSON representation
A plattform-agnostic web-project boilerplate with SASS & JS.
- Host: GitHub
- URL: https://github.com/fboes/broilerplate
- Owner: fboes
- License: mit
- Created: 2012-08-23T08:57:04.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2021-12-28T09:51:22.000Z (almost 3 years ago)
- Last Synced: 2024-04-09T15:02:59.634Z (9 months ago)
- Language: SCSS
- Homepage:
- Size: 6.91 MB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Broilerplate
================A plattform-agnostic web-project boilerplate with SASS & JS. It serves the following goodness on a shiny plate:
* Basic directory structure for web projects
* Basic HTML structure for web templates with…
* [Open Graph](http://ogp.me/)
* [Schema.org](https://schema.org/)
* [IndieWeb Microformats](https://indieweb.org/format)
* Best practices for icons
* Development tools like…
* [Sass](https://sass-lang.com/)
* [Gulp](https://gulpjs.com/)
* [editorconfig](http://editorconfig.org/) configuration for clean code
* Git configurationInstallation
------------Setup your project:
1. Execute `/tools/init-project.sh`.
2. You may want to replace all variables (like `{{ VARNAME }}`) with a meaningful text or variable.See the [setup instructions in detail](docs/development/setup.md).
Installation of _your_ project
--------------------------------Setup your development space:
2. Install Gulp plugins via `npm install`.
4. Run `build/setup.sh`.Developing
----------1. Gulp way: Start Gulp watcher via `gulp watch`. This will start the Gulp watcher responsible for compiling SASS, linting JS, reloading your page on changes and doing other useful stuff.
2. Develop (and check for advice given by the Gulp watcher).
3. Commit to your repository.See `docs/development` for more information
Version / Status
----------------See [change log](CHANGELOG.md)
[![devDependency Status](https://david-dm.org/fboes/broilerplate/dev-status.svg)](https://david-dm.org/fboes/broilerplate?type=dev)
Legal stuff
-----------Author: [Frank Boës](http://3960.org)
Copyright & license: See [LICENSE.txt](LICENSE.txt)