sharpetronics.com/README.md
2022-09-15 11:26:07 -04:00

3.1 KiB

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 displays 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.

Architecture Features (includes both: software & hardware)

  • JAMstack (Jekyll, API's, Markup)
  • Lightweight, Responsive & Static!
  • SCSS ready!
  • Developer Friendly!
  • Docker super machines!
  • Web3 Ready!
  • Blog ready with collections and pagination.
  • A clean minimal design.
  • SharpeTronics Pages ready (free static hosting).
  • Drone CI / CD system.
  • Backups for restoring to previous states.
  • Headless CMS with superpowers!
  • Ease of use for editors and writers.
  • Distributed CDN with automatic HTTPS (Cloudflare).
  • Secure ecommerce shopping.
  • International Multi-language

Jekyll Plugins

  • Menus
  • Tagging
  • Feed
  • Archives
  • Pagination v2

All Ruby dependencies are created and stored in the Docker container.

API's

  • SharpeTronics Strapi Content Management System (CMS)
  • Stripe Ecommerce Integration

System Requirements

  • Install & Configure Docker Engine (Community)
  • Install & Configure Docker-Compose
  • Install & Configure Git

Currently, the integration is maintained with Ubuntu 20.04 LTS Linux operating system, although, it is possible to use with Macintosh or Windows. The setup with docker and docker-compose will be similar as the Linux workflow; please see Further Reading for more details or get involved at: https://discord.gg/TUZ6P7BV.

Clone, Build & Launch

  1. In local directory for development, https://git.sharpetronics.com/sharpetronics/sharpetronics.com.git
  2. cd sharpetronics.github.io
  3. docker-compose up or docker compose up

Happy Hacking!!! :)

Further Reading

Socials