Skip to content
/ static-playground Public template

A boilerplate including hot-reload and HTML templates to prototype static websites with a minimal footprint.

Notifications You must be signed in to change notification settings

adrianmg/static-playground

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Static Playground

Preview of the playground

A boilerplate including hot-reload and HTML templating to prototype static websites with a minimal footprint. It comes with:

  • Nunjucks HTML template engine with pages and templates
  • Sass for styling: code in separate files, generate a single CSS file
  • An automatic process to compile your site to static HTML
  • A webserver with hot-reload
  • An external server: test your site on mobile and other devices
  • Real-time synchronization between connected devices
  • Remote web inspector tools to debug from the different connected devices
  • Support for HTML, CSS, JS and other static files

Installation and Usage

To start using it simply clone this repository and run the following commands on your terminal:

npm install
npm start

This will generate a dist folder with the compiled files so that you can deploy your project to any provider quickly.

It will automatically start a local server at http://localhost:3000. You can customize what files are watched and other options in res/bs-config.js.

If you visit http://localhost:3001, you will see a dashboard to customize other options from Browsersync.

There's also an external server at http://<your-ip>:3001 that you can use to test your website directly from other devices sharing the same network. This is great to quickly test things on your phone with hot-reload as well as syncronized scrolling.

Beyond the basics

Although it's not part of this boilerplate, you can grow the functionality by adding [Parcel] to bundle your JS modules.

License

The tool is available as open-source under the terms of the MIT License.

About

A boilerplate including hot-reload and HTML templates to prototype static websites with a minimal footprint.

Topics

Resources

Stars

Watchers

Forks