https://github.com/lassehaslev/kickstart
Kickstart is a starter kit for creating and testing static sites.
https://github.com/lassehaslev/kickstart
Last synced: 4 months ago
JSON representation
Kickstart is a starter kit for creating and testing static sites.
- Host: GitHub
- URL: https://github.com/lassehaslev/kickstart
- Owner: LasseHaslev
- Created: 2016-08-23T13:26:25.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T03:54:52.000Z (over 8 years ago)
- Last Synced: 2025-02-23T18:16:58.911Z (over 1 year ago)
- Language: HTML
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kickstart
> Kickstart is a starting point for creating and testing static sites.
This system uses
- [laravel-mix](https://github.com/JeffreyWay/laravel-mix) to compile your assets using webpack.
## Quick start
``` bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/LasseHaslev/Kickstart/master/install.sh)"
```
## Usage
### `npm run watch`
You can see the banner when working on it simply by writing `npm run watch`.
This will start [Browser Sync](https://www.browsersync.io/) and will display your content, and refresh your browsers every time you save a file.
If you want to test your banners on different devices you can see in the terminal after you entered the command.
There will be a `External` info with a `ip-address`.
Copy paste that info into your browser on your external devices and watch the magic happens.
> Note: All the external devices must be on the same local network as your development machine.
### `npm run prod`
The `npm run prod` command is minifying css and javascript and removes source maps.
### Files
#### `index.html`
Contains basic html to get you started.
#### `src/`
Contains both the style and javascript files.
#### `webpack.mix.js`
Contains the webpack configuration using [laravel-mix](https://github.com/JeffreyWay/laravel-mix).
### Using npm
This package comes with two preinstalled packages.
- [VueJs - JavaScript framework](https://vuejs.org/)
- [Bulma - CSS framework based on Flexbox](https://bulma.io/)
You are free to remove and install other packages using npm like:
```bash
npm install jquery
```
## Development
``` bash
# install dependences
npm install
# Open browser and watch for changes
npm run dev
#compile and minify resources
npm run build
```