/buildup-ws-starter

A starter website boilerplate built from the ground up, tagging complexities along the way.

Primary LanguageCSS

Build-up Website Starter (buildup-ws-starter)

A website starter kit built from the ground up with tags and branches detailing added complexity along the way.

Setting up a new project

First, clone this repo to a location on your computer. Change the folder name to the name of your project.

git clone git@github.com:bbodine1/buildup-ws-starter.git folderName

Now cd into that folder and change the git remote from the build-up starter to your new project

git remote add origin your@reponame.git - example reponame git@github.com:bbodine1/test.git

Lastly, push your new project to your new repo

git push -u origin master

Once the new project is setup

How to Create

Update the readme to use your own project readme. This will rename the bu-starter readme.md to setup.md and create a generic readme.md Run npm run create.

How to build

To build this project run npm install. The page will launch in your browser at localhost:3000 . npm start is called automatically after npm install is ran.

How to Clean

To reset the project back to the last git commit, run npm run clean. You will need to re install all npm modules to start up again.

How to Start and Serve

To serve this project run npm start. The page will launch in your browser at localhost:3000

Configurations

To configure the build process, edit the config.js located in the gulp folder.

What this readme is for

This readme will timeline all the changes made and callout tags and branches, describing what each tag or branch is and how it changes the starter.

  • TAG 0.5 - Base html5 starter with a css stylesheed and a simple javascript file. w/ Gulp, SASS, Watch and BrowserSync. This Tag has a src > build structure. Introducing Gulp Del for cleaning the build folder and Run-Sequence to prevent race conditions while building.

  • TAG 0.4 - Base html5 starter with a css stylesheed and a simple javascript file. w/ Gulp, SASS, Watch and BrowserSync.

  • TAG 0.3 - Base html5 starter with a css stylesheed and a simple javascript file. w/ Gulp, SASS and Watch.

  • TAG 0.2 - Base html5 starter with a css stylesheed and a simple javascript file. w/ Gulp.

  • TAG 0.1 - Base html5 starter with a css stylesheed and a simple javascript file.