sharpetronics.com/README.md

61 lines
2.6 KiB
Markdown
Raw Normal View History

2021-01-13 18:58:23 -05:00
# Summary
This web application is the core website for SharpeTronics.com. It is a live JAMstack (Jekyll, API's, Markup) example of the power of static websites with micro services that includes all the bells and whistles for comments, newsletter subscriptions, content management systems (CMS), site generators, blog posts, continuous delivery (CD), version management, ecommerce shopping, progressive web applications (PWA), and many more.
Javascript frameworks create more complexity than needed, this example portrays minimal need for Javascript; therefore increasing security, reducing file size and complex work environments, increasing load times and reducing the learning curve for web developers, while keeping all the fun and speedy reactivity of the modern web architecture. We enable more focus on design and content; while enabling increased portability, automated testing, speed and security.
No proprietary operating system dependencies required, only Docker Engine super machines and some tender love and care. The base stack is Docker Engine + SCSS ready!
# Stack Architecture Features
* JAMstack (Jekyll, API's, Markup)
* Lightweight, Responsive & Fast!
* SCSS ready!
* Developer Friendly
* Docker super machines!
* Distributed CDN with automatic HTTPS
* Blog ready with collections and pagination
* Clean minimal design
* GitHub Pages ready (Free hosting)
* GitHub Actions for expanding Jekyll usability
* < Siteleaf CMS ready with user roles
* < Comments with administration
* < Ecommerce shopping
* < Newsletter subscriptions
* < Search functionality
* < Web workers for caching data for speedy progressive web application (PWA)
# Jekyll Plugins
* Menus
* Tagging
* Feed
* Archives
* Picture Tagging
* Pagination v2
# API's
* Siteleaf CMS
* Staticman with GitHub
* Snipcart with Stripe
* Mailjet Newsletters
* Algolia Search
All Ruby dependencies are created and stored in the Docker container. Simple, smooth and sweet :)
# Requirements
* Install Docker Engine (Community)
* Install Docker-Compose
* Install Git
* Optional: If using Jekyll picture-tagging plugin, you will need to login to docker container and install the image-magick dependency; see docker-compose.yml file.
## Clone, Build & Launch
1. In local directory for development, ```git clone https://github.com/SharpeTronics/folder-name-example/```
2. ```cd folder-name-example``
3. ```docker-compose up```
*Happy Hacking! :)*
## Further Reading
* Docker Engine https://docs.docker.com/install/
* Docker Compose https://docs.docker.com/compose/install/
* Jekyll https://jekyllrb.com/
* Git https://git-scm.com/book/en/v2/Getting-Started-Installing-Git