hologramofme / mizuxes-web-template Goto Github PK

## Mizukes is a single page website template aimed at selling a single
## product like a book or even an event.

## It makes use of Bootstrap 4.1.1 and Font Awesome

## Font Awesome files are ignored in this repo because no changes to these
## have been made nor is there any intention to do so. If you follow the
## workflow steps below for building the project the files will be created
## upon install using npm.

## Image files have also been ignored to save storage space and sync efficiency.
## They are just place holder images anyway. So you aren't really missing out
## on much there.



## Commands to create workflow. Below text can be copy/pasted into a .sh file
## if you feel the need to automate.
## ============================

#!/bin/bash

$ mkdir {directory_name}
$ cd directory_name
$ npm init
$ atom .      ## this is not needed but helps open the package.json file
              ## for editing and monitoring during following steps.
$ npm install [email protected] font-awesome jquery popper.js --save
$ npm install gulp gulp-sass browser-sync --save-dev

## Uncomment the next line only if gulp is not already installed globally
## $ sudo npm install -g gulp-cli



## ==================================
## Once this has been done you can run gulp and it will
## execute all the commands in gulpfile.js and compile and
## move all the appropriate css and js files.
## Then all that remains to do is delete the node-modules directory
## and anything else leaving only
## /src
## gulpfile.js
## package.json

## which is all the files you need to start a new project
## Copy/Paste those files into a new project folder to begin.

## Finally once pasted into project folder run
$ npm install
$ npm start