https://github.com/xiaohutai/bolt-theme-starter
[Bolt Theme] A starter theme **WIP**
https://github.com/xiaohutai/bolt-theme-starter
bolt cms js scss theme twig
Last synced: about 2 months ago
JSON representation
[Bolt Theme] A starter theme **WIP**
- Host: GitHub
- URL: https://github.com/xiaohutai/bolt-theme-starter
- Owner: xiaohutai
- License: mit
- Created: 2018-07-31T13:18:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-22T15:37:24.000Z (almost 8 years ago)
- Last Synced: 2025-01-23T00:43:30.446Z (over 1 year ago)
- Topics: bolt, cms, js, scss, theme, twig
- Language: HTML
- Homepage:
- Size: 488 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Starter, a Bolt Theme 
Installation
| Getting Started
| Configuration
| Folder Structure
| Recommendations
| Fundamentals
| References
---
## Installation
There are two options to get this theme:
- Install this theme via the Bolt backend at `/bolt/extensions`.
- Do a `composer require xiaohutai/bolt-theme-starter` in your Bolt's `extensions` folder.
For making pull requests, navigate to your Bolt's `themes` folder and clone this repo:
```sh
git clone git@github.com:xiaohutai/bolt-theme-starter.git
```
## Getting Started
```sh
# Install dependencies
npm install
# For development: Serve the website with hot reload for css and js files.
npm start
# For production: Build and minify all assets.
npm run build
```
| Command | Description | Minification? |
|:-----------------------|:-----------------------------------------|:-------------:|
| `npm run sass` | Compile SASS to CSS |  |
| `npm run postcss` | PostCSS (polyfill, autoprefixer) |  |
| `npm run styles` | Build styles (`sass` + `postcss`) |  |
| `npm run scripts` | Compile JS |  |
| `npm run build` | Build everything (`styles` + `scripts`) |  |
| `npm run lint` | Lint styles |  |
| `npm run eslint` | Lint scripts |  |
## Configuration
| Name | File | Github | More info |
|:------------------------------------------------------------|:--------------------|:------:|:----------|
| [Babel](https://babeljs.io) | `.babelrc` | [:octocat:](https://github.com/babel/babel) | [.babelrc](https://babeljs.io/docs/en/babelrc.html), [babel-preset-env](https://babeljs.io/docs/en/babel-preset-env) |
| [ESLint](https://eslint.org) | `.eslintrc.js` | [:octocat:](https://github.com/eslint/eslint) | [Configuring](https://eslint.org/docs/user-guide/configuring), [ESLint rules](https://eslint.org/docs/rules/) |
| [PostCSS](https://postcss.org/) | `.postcssrc` | [:octocat:](https://github.com/postcss/postcss) | |
| [cssnano](https://cssnano.co/) | `cssnano.config.js` | [:octocat:](https://github.com/cssnano/cssnano) | |
| [Browserlist](https://github.com/browserslist/browserslist) | `.browserslistrc` | [:octocat:](https://github.com/browserslist/browserslist) | [browserl.ist](http://browserl.ist/) |
Check the browserslist with
```
npx browserslist
```
## Folder Structure
Folder structure
.
├── dist
│ ├── scripts
│ ├── styles
│ └── ...
├── config
│ ├── config.yml
│ ├── contenttypes.yml
│ ├── routing.yml
│ ├── extensions/boltforms.bolt.yml
│ ├── extensions/seo.bobdenotter.yml
│ └── ...
├── source
│ ├── scripts
│ ├── styles
│ └── ...
├── templates
│ ├── components
│ ├── layouts
│ ├── partials
│ └── ...
├── .babelrc
├── .browserslistrc
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .postcssrc
├── browserconfig.yml
├── CHANGELOG.md
├── composer.json
├── cssnano.config.js
├── LICENSE
├── package.json
├── package-lock.json
├── README.md
├── site.webmanifest
├── theme.yml
└── ...
## Recommendations
### Extensions
By default, this extension automatically installs the following extensions:
- `bacboslab/menueditor`
- `bobdenotter/seo`
- `bolt/boltforms`
- `bolt/sitemap`
- `twokings/bolt-searchable-content-extension`
- `twokings/hierarchical-routes`
These extensions will be uninstalled if you uninstall this theme. You can install
them separately in order to keep them:
```sh
composer require bacboslab/menueditor
composer require bobdenotter/seo
composer require bolt/boltforms
composer require bolt/sitemap
composer require twokings/bolt-searchable-content-extension
composer require twokings/hierarchical-routes
```
#### Suggested Extensions 
- `animal/translate`
- `bolt/basewidget`
- `bolt/disqus`
- `bolt/jsonapi`
- `bolt/labels`
```sh
composer require animal/translate
composer require bolt/basewidget
composer require bolt/disqus
composer require bolt/jsonapi
composer require bolt/labels
```
### Bolt Configuration 
The `config` directory has some `yml` files with useful blocks that you can copy
and paste.
- `config.yml`
- `contenttypes.yml`
- `routing.yml`
### Blocks 
### Snippets 
### Components 
## Fundamentals
### Grid 
### Color 
### Typography 
### Accessibility 
- [Inclusive Components by Heydon Pickering](https://inclusive-components.design/)
### Web App Manifest
Generate `favicon.ico`, `site.webmanifest`, and `browserconfig.xml` at [Favicon Generator](https://realfavicongenerator.net).
- [The Web App Manifest on Google Web Fundamentals](https://developers.google.com/web/fundamentals/web-app-manifest/)
## References 