marceloglacial / snowfall-boilerplate

End-to-end web project boilerplate based on three stages: Design, Front-end and Back-end (Wordpress and Docker)

Snowfall Boilerplate

End-to-end web project based on three stages:

1. Design
2. Front-end
3. Back-end

Design

• Sketch and Figma templates
• Desktop, tablet and phone artboards
• Default web icons, tiles and favicons
• WordPress screenshot artboard

Front-end

• HTML5 starter template files
• Front-end checklist
• Browser Live Reloading
• SASS
• Include-media
• HandlebarsJS
• Normalize CSS

Back-end

• WordPress
• Docker Compose
• Browser Live Reloading

CI/CD

• FTP Deploy
• Travis CI

Installation

1. Install Docker Compose
2. Install npm
3. Install Gulp
4. Run installation on terminal:

    npm install

Note: Run npm audit if you got dependencies vulnerabilities

    npm audit fix -force

How to Use

Front-end

• npm run frontend - Start developement
• npm run frontend-build - Build
• frontend:start - Starts Browser Live reloading and watch SASS files.
• frontend:build - Minify HTML/CSS/JS, Optimize images and copy do dist folder.
• frontend:deploy - Build and upload all front-end/dist files to FTP server.

Back-end

• npm run backend - Start developement (make sure Docker is running)
• backend:install - Download WordPress latest version, unzip it and setup a server folder.
• backend:start - Starts Browser Live reloading and watch SASS files.
• backend:deploy - Build theme and upload all back-end/src files to FTP server (default).

Deploy

FTP config

1. Fill FTP credentials and server info on credentials-sample.json
2. Rename credentials-sample.json to credentials.json

Note: Due sensitive information, credentials.json WILL NOT BE on version control.

References

• Front-end based on Snowflake Boilerplate
• Back-end based on Iceberg boilerplate