Web Developer Guide

We are using GitHub Flavored Markdown.

JavaScript frameworks available are:

CSS frameworks available are:

Additional testing with GitHub Actions:

For misspell you can pass in -w to autocorrect misspelled words. You can also autocorrect some markdownlint errors by using the --fix flag.

Developer Tools:

  • EditorConfig -- helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
  • GNU Midnight Commander -- is a free cross-platform orthodox file manager. It was started by Miguel de Icaza in 1994 as a clone of the then-popular Norton Commander. GNU Midnight Commander is part of the GNU project and is licensed under the terms of the GNU General Public License

IDEs that some contributors to Petri use:

  • Atom -- At GitHub, we’re building the text editor we’ve always wanted: hackable to the core, but approachable on the first day without ever touching a config file. We can’t wait to see what you build with it
  • GNU Emacs -- An extensible, customizable, free/libre text editor — and more. At its core is an interpreter for Emacs Lisp, a dialect of the Lisp programming language with extensions to support text editing
  • GNU nano -- a text editor for Unix-like computing systems or operating environments using a command line interface. It emulates the Pico text editor, part of the Pine email client, and also provides additional functionality. Unlike Pico, nano is licensed under the GNU General Public License. Released as free software by Chris Allegretta in 1999, nano became part of the GNU Project in 2001
  • IntelliJ IDEA Community -- Every aspect of IntelliJ IDEA has been designed to maximize developer productivity. Together, intelligent coding assistance and ergonomic design make development not only productive but also enjoyable
  • Sublime Text -- Sublime Text is a sophisticated text editor for code, markup and prose. You'll love the slick user interface, extraordinary features and amazing performance
  • Vim -- a highly configurable text editor built to make creating and changing any kind of text very efficient. It is included as “vi” with most UNIX systems and with Apple macOS

Useful Git tools:

  • GitHub Desktop -- Simple collaboration from your desktop
  • GitKraken -- Free Git GUI for Windows, Mac, Linux
  • Git GUI Clients
  • gitk -- The Git repository browser
  • git-gui -- A portable graphical interface to Git
  • gitg -- a graphical user interface for git
  • GitHub CLI -- Take GitHub to the command line. GitHub CLI brings GitHub to your terminal. Free and open source

Test your website:

  • Facebook Sharing Debugger -- Sharing Debugger lets you preview how your content will look when it's shared to Facebook and debug any issues with your Open Graph tags
  • Favicon checker -- Is your favicon perfect? Let us give a look. We check more than a dozen settings to make sure it fits all major platforms
  • Google Rich Results Test -- Rich results are experiences on Google surfaces, such as Search, that go beyond the standard blue link. Rich results can include carousels, images or other non-textual elements
  • GTmetrix -- See how your site performs, reveal why it's slow and discover optimization opportunities
  • Help Search Engines Understand Your Website -- Preview and Generate Open Graph Meta Tags
  • Lighthouse -- Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, SEO and more
  • Mobile-Friendly Test -- Test how easily a visitor can use your page on a mobile device. Just enter a page URL to see how your page scores
  • Nu HTML Checker
  • PageSpeed Insights -- Make your web pages fast on all devices
  • Pingdom Website Speed Test -- Enter a URL to test the page load time, analyze it, and find bottlenecks
  • REDbot -- REDbot is lint for HTTP resources; it tests protocol correctness, cacheability, content negotiation and more
  • Twitter Cards Validator
  • W3C Feed Validation Service -- Free service that checks the syntax of Atom or RSS feeds
  • W3C Markup Validation Service
  • WebPageTest -- Test. Optimize. Repeat