Skip to content

Simple boilerplate, without any build pipeline, for practice and teaching purpose.

Notifications You must be signed in to change notification settings

topheman/build-free-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

build-free-boilerplate

In a time where even for a "Hello World" project, you need to setup a whole build/transpile pipeline with webpack (or other tools), the goal of this project is to:

  • have a simple starter kit
  • without any build tool to configure
  • directly using UMD build
  • with a few simple examples (for ES6, React ...)

Main purpose

You may not use that kind of boilerplate for production but for practice or teaching purpose.

Install

npm install

Run

npm start

Goto http://localhost:5000

It will livereload pages and resources (based on browsersync).

Note: Your html pages will need to have at least a <body> tag (so that browsersync can inject some script).

If you don't want the live-reload / cross-device sync features from browsersync, instead of the previous command, use the following:

npm run serve

Build

Build ? You said no build step ...?

The online demo is hosted on github pages which serves static pages where you can't have dynamic listing of directories with no index.html files (like most servers do), which can be interesting to discover the content of the site.

I made a little script to generate the index.html home page file at the root that will include a list of all the files in the src directory.

npm run build

Deploy

The online demo is hosted on github pages (to deploy you need to push to a gh-pages branch).

Since we don't have any build step, we simply push master onto gh-pages with the following syntax:

git push origin master:gh-pages

Note: git push <REMOTENAME> <LOCALBRANCHNAME>:<REMOTEBRANCHNAME> (see article)

License

This software is distributed under an MIT licence.

Copyright 2018 © Christophe Rosset

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.

This is a work in progress.

About

Simple boilerplate, without any build pipeline, for practice and teaching purpose.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published