ContextQMD
Back to Hackathon Starter

PROD CHECKLIST

PROD_CHECKLIST.md

10.0.03.7 KB
Original Source

If you are done with your hackathon and thinking about launching your project into production, or if you are just using this boilerplate to start your soon to be in production application, this document is a checklist to help you get your application production ready.

  • Remove unused code and configs
  • Add a proxy such as Cloudflare in front of your production deployment. Adjust the numberOfProxies logic in app.js if needed
  • Update the session cookie configs with sameSite attribute, domain, and path
  • Add Terms of Service and Privacy Policy
  • Update LICENSE.md and the relevant license field in package.json if applicable - See npm's doc.
  • Add sitemap.xml and robots.txt
  • Update Google Analytics ID
  • Add Facebook App/Pixel ID
  • Add Winston Logging, and replace console.log statements with Winston; have a process for monitoring errors to identify bugs or other issues after launch.
  • SEO and Social Media Improvements
  • Create a deployment pipeline with a pre-prod/integration test stage.
  • (optional) Add email verification Some experimental data has shown that bogus email addresses are not a significant problem in many cases
  • (optional) Add a filter with disposable-email-domains. Some experimental data has shown that use of disposable emails is typically rare, and in many cases it might not be worth adding the filter.

Remove unused code and configs

The following is a list of various code that you may not potentially be using and you could remove depending on your application:

  • Unused keys from .env file
  • /controllers/api.js entirely
  • /views/api entirely
  • app.js:
    • multer
    • apiController
    • Openshift env references
    • csrf check exception for /api/upload
    • All API example routes
    • OAuth routes for authentications that you are not using (i.e. GitHub, LinkedIn, etc. based on your app)
    • All OAuth authorization routes
  • passport.js all references and functions related to:
    • Github, LinkedIn, OpenID, OAuth, OAuth2
  • model/User.js
    • key pairs for Github, LinkedIn, Steam
  • package.json
    • @octokit/rest, lastfm, lob, multer, node-linkedin, passport-github2, passport-linkedin-oauth2, passport-oauth, paypal-rest-sdk, stripe, twilio
  • /test
    • Replace E2E and API example tests with new tests for your application
  • views/account/login.pug
    • Some or all of the last form-group set, which are the social login choices
  • views/account/profile.pug
    • Link/unlink buttons for GitHub, LinkedIn, Steam
  • Remove README, changelog and this guide if not using them
  • Create a domain whitelist for your app in Here's developer portal if you are using the HERE Maps API.
  • Add unit tests so you can test and incorporate dependency and upstream updates with less effort. GPT tools may create some good unit tests with very low effort.

Search Engine Optimization (SEO)

Note that SEO only applies to the pages that will be publicly visible with no authentication. Note that some of the following fields need to be added to the HTML header section similar to the page title

  • Add Open Graph fields for SEO Open Graph data:

    <meta property="og:title" content="Title">
<meta property="og:type" content="website">
<meta property="og:url" content="http://www.example.com/article.html">
<meta property="og:image" content="http://www.example.com/image.png">

  • Add a page description, which will show up in the search results of the search engine.

    <meta name="Description" content="Description about the page.">