https://github.com/tomgp/starter-kit
a quickstart for making static web pages
https://github.com/tomgp/starter-kit
Last synced: about 1 month ago
JSON representation
a quickstart for making static web pages
- Host: GitHub
- URL: https://github.com/tomgp/starter-kit
- Owner: tomgp
- Created: 2015-10-15T14:59:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-12T15:53:50.000Z (over 10 years ago)
- Last Synced: 2025-03-03T09:44:21.660Z (over 1 year ago)
- Language: CSS
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
##What it is
A quick start for making static websites.
##What you need
[NodeJS](https://nodejs.org/) for bundling JS, [Git](https://help.github.com/articles/set-up-git/)
[Python](https://www.python.org) for a simple http server (temporarily until I find somethignin node that fits the bill)
##What do you get
Some halfway decent default CSS ([for examle](http://www.toffeemilkshake.co.uk/starter-kit/))
Bundles Javascript using `require('the-module-name')` type syntax ([browserify](http://browserify.org/))
Re-builds the JS bundle on changes ([watchify](https://www.npmjs.com/package/watchify))
Local live reloading webserver ([srvlr](https://github.com/kavanagh/srvlr))
ES6 pollyfils ([babelify](https://github.com/babel/babelify))
##How you use it
To get going open terminal and type in the following things
clone the repo:
`git clone https://github.com/tomgp/starter-kit.git my-new-webpage`
go to the new thing you made:
`cd my-new-webpage`
point it to a new remote i.e. you may wish to use your own github account or something:
`git remote set-url origin https://github.com/yourusername/my-new-webpage.git`
get all the js stuff:
`npm install`
(if you want other modules, eg. 'd3' you can install them as usual `npm install --save d3`)
run a live reloading server and something to build the javascript:
`npm run start`
(where `my-new-webpage` is the name of your new web page)
By default HTML is _index.html_, styles in _style.css_ and you can write Node style Common JS modules in the _source_ directory.