6.0 KiB

Raw Permalink Blame History

The Visual Identity of <%= @project_name %>

Base Template
CSS
JavaScript

This module contains the base HTML templates for the application, as well as the webpack and scss configuration so that it's clear how all this fits together. I am not sure how to manage this reasonably for now. There's not a lot of assets for now, luckily.

Base Template

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <link rel="manifest" href="/appmanifest.json">
    <%%= csrf_meta_tag() %>
    <title><%%= assigns[:page_title] || "Lipu Kasi, Plant Diary" %></title>
    <link rel="stylesheet" href="<%%= Routes.static_path(@conn, "/css/app.css") %>"/>
    <link rel="stylesheet" href="<%%= Routes.static_path(@conn, "/css/foundation.css") %>"/>
    <link rel="stylesheet" href="<%%= Routes.static_path(@conn, "/css/aesthetics.css") %>"/>
    <script defer type="text/javascript" src="<%%= Routes.static_path(@conn, "/js/app.js") %>"></script>
    <script defer type="text/javascript" src="<%%= Routes.static_path(@conn, "/js/foundation.js") %>"></script>
  </head>
  <body>
    <header class="top-bar">
      <section class="top-bar-left">
        <ul id="dropdown" class="dropdown menu" data-dropdown-menu>
          <li class="menu-text"><%%= assigns[:site_title] %></li>
          <li>
              <a>Points of Interest</a>
              <ul class="menu vertical">
                  <li><a href="https://rix.si/">Lion's Rear</a></li>
                  <li><a href="https://arcology.garden/">Arcology Garden</a></li>
                  <li><a href="https://doc.rix.si/">Docsite</a></li>
                  <li><a href="https://doc.rix.si/cce.html">Complete Computing Environment</a></li>
              </ul>
          </li>
        </ul>
      </section>
    </header>

    <main role="main">
        <p class="grid-x" role="alert"><%%= get_flash(@conn, :info) %></p>
        <p class="grid-x" role="alert"><%%= get_flash(@conn, :error) %></p>

        <%%= render @view_module, @view_template, assigns %>
    </main>

    <footer class="grid-container">
        <hr/>
        <div class="grid-x">
            <p class="text-center cell">
                <em>
                    Effort has been made to ensure accurate and
                    thoughtful content, but I am one human. Please
                    assume good faith and contact me with suggestions
                    for improvement or areas of interest.
                </em>
            </p>
            <p class="text-center cell">
                &copy; 02020 Ryan Rix &lt;<a href="mailto:site@whatthfuck.computer">site@whatthefuck.computer</a>&gt;
            </p>
        </div>
    </footer>
  </body>
</html>

CSS

In the base template I have three CSS entrypoints defined, and this is mirrored in webpack.config.js:

app.scss - semantic markup
foundation.scss - the entire Foundation CSS bundle
aesthetics.scss - a bundle containing font-face rules, colors, etc

Additionally, Foundation has a _settings.scss file that is imported in a few places, it just sets a ton of SCSS variables.

JavaScript

There are a few JavaScript entrypoints in the webpack.config.js:

`js/app.js` – our code goes here.

This is where all of my front end logic will come by loaded or stored. For now there's not much, so I'll pull this out when it gets out of hand.

// We need to import the CSS so that webpack will load it.
// The MiniCssExtractPlugin is used to separate it out into
// its own CSS file.
import "../css/app.scss"

// import "./live.js"

// if('serviceWorker' in navigator) {
//   navigator.serviceWorker.register('/js/sw.js', {
//     scope: '/'
//   }).then(function() {
//     console.log('Service Worker Registered');
//   });
// }

`js/foundation.js` – foundation's code goes here.

Loading foundation is a pretty simple affair, foundation.core and whatever UI elements needed are all that are loaded, and then call the foundation initialization function. Easy.

import "jquery"

import "../css/foundation.scss"

import 'foundation-sites/dist/js/plugins/foundation.core';
import 'foundation-sites/dist/js/plugins/foundation.dropdownMenu.min.js';
import 'foundation-sites/dist/js/plugins/foundation.util.keyboard.min.js';
import 'foundation-sites/dist/js/plugins/foundation.util.box.min.js';
import 'foundation-sites/dist/js/plugins/foundation.util.nest.min.js';

$(document).foundation();

`js/sw.js` – Service Worker for Progressive Web App

It's not clear to me how well this will handle offline behavior, I'm not sure I really care for it, though I should. The service worker will let us figure that out later, for now it caches stylesheets.

const cacheName = 'lipu-kasi';
const filesToCache = [
  '/',
  '/css/app.css',
  '/css/foundation.css',
  '/css/aesthetics.css',
];

self.addEventListener('install', function(e) {
  console.log('[lipu kasi Service Worker] Installing');
  e.waitUntil(
    caches.open(cacheName).then(function(cache) {
      console.log('[lipu kasi Service Worker] Caching files for app');
      return cache.addAll(filesToCache);
    })
  );
});

self.addEventListener('activate', event => {
  event.waitUntil(self.clients.claim());
});

self.addEventListener('fetch', event => {
  if (event.request.method !== 'POST') {
    event.respondWith(
      fetch(event.request).catch(function() {
        return caches.match(event.request);
      })
    );
  } else {
    event.respondWith(fetch(event.request));
  }
})

6.0 KiB Raw Permalink Blame History Unescape Escape