riiiad / riiiad-starter-kit Goto Github PK

View Code? Open in Web Editor NEW

A starter package for compiling Sass, Pug, TypeScript and running a dev server. Kickstart your projects.

JavaScript 16.32% CSS 66.06% HTML 17.38% TypeScript 0.24%

riiiad-starter-kit's Introduction

Riiiads Starter Kit

A starter kit for compiling Sass, Pug and running a dev server. Now also with typescript compiler. Created by Riad ZT [email protected]

This package is inspired by the Traversy Media and Dev Tips starter kits. Check out the starter kits they are awesome.

TM: https://github.com/bradtraversy/sass_starter_pack

DevTips: https://github.com/DevTips/DevTips-Starter-Kit

Version

1.1.0

Installation

Install the dependencies (gulp, gulp-sass, gulp-pug, gulp-concat, gulp-imagemin, gulp-uglify, del, browser-sync, typescript, gulp-typescript)

$ npm install

(Optional)Install gulp globally if you want to run the gulp command in your CLI.

$ npm install -g gulp

Usage

This kit works with pug by default. You change the pug files in the pug folder and the files are compiled to html.

In the assets folder you upload the images and js files this folder will be copy to the build folder.

With the last version typescript was added. You can use it or not just be careful if you save changes to the main.ts file the main.js will be overwritten. Best is if you DO NOT want to use typescript just delete the main.ts file and it will not be compiled to main.js.

Never change the src/index.html or the assets/css/ files because it will be overwritten with the compiled files.

Run

This will watch your sass/pug files and run your dev server at http://localhost:3000

$ npm start

Run without Pug(testing)

There is a gulp no-pug option, this will only run sass compiling and the dev server. You just change the index.html file in the src/no-pug folder.

You have to refresh the site to see changes, auto-refresh is still not working.

$ gulp no-pug

Ready for deployment

After you are ready to deploy you project. Run this command to create the dist folder and your files will be ready to deploy. Just upload the files in the dist to your server.