time-converter

An offline web time converter. Built using Gatsby.js.

Meant to be a very static site. Only using front-end/client-side/browser features.

See "Updating Published App" for details on how to update the app if you are customizing your own copy of this repository.

Before you start development

You will need Node.js. You may need an updated version of Node.js. Run gatsby --version LATER to find out which one.

Get Gatsby CLI too:

npm install -g gatsby-cli

You can check for success with gatsby --version.

Contributing to or customizing this application

DSTs and locations might change over time, so one way to make a significant contribution would be to keep these things updated.

Locations

Currently, each location and linked time-zone follows this format:

{ 
  location: 'Boston', 
  timeZone: 'America/New_York' 
}

The current time zones are from tzdb-2019c -> zone1970.tab. (https://www.iana.org/time-zones)

IANA time zones are extracted to:

tz-and-comments-only-raw.js using extract-tz-comments.js

They take the format:

{
  "TZ": "Antarctica/Rothera",
  "comments": "Rothera"
}

Where TZ contains the IANA time zone, and comments for the official IANA time zones are not really important and are not currently used.

Custom US time zones are COMBINED/CONCATENATED to the IANA time zones (tz-and-comments-only-raw.js) in:

combined-us-time.js using add-custom-timezones.js

Custom time zones take the format:

{
  "TZ": "US PT Pacific Time (C)",
  "comments": "America/Los_Angeles"
}

Where the (C) at the end of TZ indicates a custom time zone, and the IANA time zone is now moved into the comments (the comments ONLY consists of the IANA time zone). You can add any name in front of the (C). Both TZ and comments are used for custom time zones.

During development in React.js components, custom time zones are handled by using this condition:

indexOf("(C)") !== -1

Just do a search for this condition in all of the *.js files using your favorite code editor.

DST

If Luxon/browser APIs/existing sources are already handling this, I'll see if I can update this in the future to handle DST changes down to the hour.

Other things to be done

Accessibility
Testing/Support for low-price devices
Format customization (as in DD MM YYYY etc.)

Publishing to GitHub

If you encounter any problems, you can try to remove the node_modules directory and package-lock.json file.

Then run npm i again to reinstall node modules.

See babel/babel#11216 (comment)

Updating Published App

Run npm run deploy.

Note: See "First-Time Set Up" if the app has not been published to GitHub yet.

Do not change to the gh-pages branch. There is no .gitignore file there. Things might crash. The only time you ever need to touch the gh-pages branch is when you first create it (with nothing inside it) on the remote/local.

When you run npm run deploy all contents of the public folder will be moved to your repository’s gh-pages branch.

First-Time Set-Up

Update ./gatsby-config.js.

// In gatsby-config.js:
module.exports = {
  pathPrefix: "/reponame",
}

Update ./package.json

// package.json
"scripts": {
  "deploy": "gatsby build --prefix-paths && gh-pages -d public"
}

Run npm run deploy.

Your app should automatically appear at:

https://yourusername.github.io/reponame/

All contents of the public folder will be moved to your repository’s gh-pages branch. A commit is automatically created and pushed to the remote gh-pages branch.

Development

Run gatsby develop.

Building and Production

Run gatsby build to build the project and output to the root ./public folder.

Run gatsby serve after building to serve the build.

wlwl2/time-converter