Skip to content

Commit

Permalink
Update prod-checklist.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YasharF committed Jul 29, 2023
1 parent 9dbaf8e commit f6cad15
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions prod-checklist.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
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.

- Update the To/From email address for the Contact Form and the Lost Password controller codes
- Remove Unused code and configs
- Add a proxy such as Cloudflare in front of your production deployment
- Add a proxy such as Cloudflare in front of your production deployment. Adjust 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](https://docs.npmjs.com/files/package.json#license).
- Add [sitemap.xml](https://en.wikipedia.org/wiki/Sitemaps) and [robots.txt](https://moz.com/learn/seo/robotstxt)
Expand All @@ -12,7 +12,7 @@ If you are done with your hackathon and thinking about launching your project in
- 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 for [disposable-email-domains](https://www.npmjs.com/package/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 to add this filter.*
- (optional) Add a filter with [disposable-email-domains](https://www.npmjs.com/package/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 add the filter.*


### Remove unused code and configs
Expand All @@ -21,28 +21,28 @@ The following is a list of various codes that you may not potential be using and
- /controllers/api.js entirely
- /views/api entirely
- app.js:
- chalk usage
- multer
- apiController
- Openshift env references
- csrf check exception for /api/upload
- All API example routes
- OAuth routes for Instagram, Github, LinkedIn (kept Facebook, Twitter, and Google)
- 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:
- Instagram, Github, LinkedIn, OpenID, OAuth, OAuth2
- Github, LinkedIn, OpenID, OAuth, OAuth2
- model/User.js
- key pairs for Github, Instagram, LinkedIn, Steam
- key pairs for Github, LinkedIn, Steam
- package.json
- @octokit/rest, chalk, instagram-node, lastfm, lob, multer, node-foursquare, node-linkedin, passport-github, passport-instagram, passport-linkedin-oauth2, passport-oauth, passport-openid, paypal-rest-sdk, stripe, tumbler.js, twilio
- @octokit/rest, lastfm, lob, multer, node-linkedin, passport-github2, passport-linkedin-oauth2, passport-oauth, paypal-rest-sdk, stripe, twilio
- /test/app.js
- /api test case
- 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 Instagram, Github, LinkedIn, steam
- Link/unlink buttons for Github, LinkedIn, steam
- Removed readme, changelog, this guide, docker related files if not using them
- Create a domain whitelist for your app in Here's developer portal if you are using the Here's map 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](https://github.com/sahat/hackathon-starter/blob/master/views/layout.pug#L9)
Expand Down

0 comments on commit f6cad15

Please sign in to comment.