Skip to content

Latest commit

 

History

History
46 lines (40 loc) · 3.21 KB

README.md

File metadata and controls

46 lines (40 loc) · 3.21 KB
Raw

Dev Notes

This is a repository of guides, tutorials, code snippets, and general notes for various types of software development.

The intended audience is mostly my forgetful self, however, if others stumble upon this repository and find it useful, then all the better!

Running the Site Locally

Use jekyll's built-in simple server:

# From within the docs/ directory.
$ bundle exec jekyll serve

TODO

  1. Add notes on using Jekyll
    1. Using webpack and React with Jekyll (https://medium.com/@allizadrozny/using-webpack-and-react-with-jekyll-cfe137f8a2cc)
    2. Using React, Webpack, and Babel (https://dev.to/shivampawar/setup-webpack-and-babel-for-a-react-js-application-24f5, also see https://github.com/Pathos-Design-Studio/pathos-site/commit/6ea66b3dd0b0f68c6890164483d4566c5556d6a3)
    3. Using Flow, ESLint, and Prettier (https://flow.org/en/docs/install/, https://flow.org/en/docs/tools/eslint/, option 2 here: https://stackoverflow.com/questions/51563112/flow-throws-error-cannot-resolve-module-react-redux-even-tho-its-installed, and impl here https://github.com/Pathos-Design-Studio/pathos-site/commit/954b0c235c0cab5e06737c80d427722bc80991de)
    4. Integrating Strapi with Jekyll (https://strapi.io/blog/building-a-static-website-using-jekyll-and-strapi)
  2. Add notes on using React
    1. Add notes on using React with strapi (https://docs.strapi.io/dev-docs/integrations/react)
  3. Add UX implementation notes
    1. CSS notes - Mozilla Guide
      1. Popular CSS frameworks
      2. Critical concepts: css selectors, cascade/specificity/inheritance, box-model, flexbox/grids/floats/positioning
      3. Implementing accessibility guidelines
  4. Add Rails notes top section
    1. Generating a new app
    2. Generating tests and testing
  5. Add CI/CD notes - Jenkins
  6. Add DevOps notes on deploying Rails
    1. How to deploy in production mode to reduce source bundle size and memory footprint (make sure to add RAILS_ENV to production and update RACK_ENV to deployment)
    2. How to add pre-commit hooks (esp. testing hooks) - pre-commit repo, pre-commit ci docs
  7. Add notes on Python gotchyas
    1. Writing packages
    2. Relative vs. absolute imports and directory context switching (note: always use absolute) -- see stackoverflow
    3. Updating virtual env to point to your local packages so they're in the python path
  8. Add visual & UX design notes
    1. Import old notes & resources - UX Design Cheatsheet
    2. Watch figma videos and write out important highlights - Visual Design, UX Design