index.md

Index

This index is autogenerated using scripts/index.py from all markdown files in how-to.

Run python scripts/index.py to re-generate this file.

Contents

File, title, and summary for each header in the how-to directory.

---

swift.md

• Swift References
  • Swift and SwiftUI references
  • Xcode
    • General useful resources for xCode
    • Xcode Shortcuts
      • Keyboard shortcuts for Xcode
  • General Resources
    • General useful resources for Swift and SwiftUI
    • hackingwithswift.com
      • Homepage: hackingwithswift.com.
    • SwiftLint
      • Linting tool for Swift and SwiftUI.
  • SwiftUI
    • SwiftUI references
    • List Selection
      • Add the selection: $selection_state parameter into List.
    • Searchable
      • Use .searchable(text: $searchText) to add a search bar to any view in a NavigationView.
    • List Row Seperator Insets
      • In iOS 16, lists have different seperator behavior. Adjust this using new alignment: listRowSeperatorLeading and
    • Date Formatting
      • Use .formatted() method in iOS 15+ to format dates into text. E.g. date.formatted(.dateTime.day().month().year())

python.md

• Python References
  • Python notes and references
  • Project Setup and Packaging
    • Python project setup, packaging, tools.
    • Project Structure
      • Typical Project Structure:
    • Project Setup
      • Provide a setup.py to enable Python project setup.
  • Builtin Modules and Functions
    • Python built-in modules, functions, and tools.
    • dataclass
      • Provides @dataclass decorator for basic functionality for classes used to hold data.
      • Unpacking Dataclasses
        • Use the dataclasses.astuple(obj) method to unpack a dataclass instance into a tuple. Note that this is recursive.
      • Dataclass __post_init__
        • Use the __post_init__ method in dataclasses to run code immediately after initialization of the dataclass'
      • Dataclass keyword-only __init__ parameters
        • Introduced in Python 3.10, dataclasses can now be created in keyword-only mode.
    • namedtuple
      • Tuple and Dictionary like objects to store values in both key-value and iterative patterns. Use collections.namedtuple
    • Pathlib
      • Python's built-in module for filesystem paths. See pathlib docs
      • Get path of current file
        • Use pathlib.Path(__file__).resolve() to get path to the current file.
      • pathlib.resolve()
        • Removes any symlinks and makes a path absolute.
    • Collections
      • The collections.abc module provides Abstract Base Classes for various containers. These containers provide various
      • Making an object subscriptable and iterable
        • Providing the __getitem__ and __setitem__ magic methods allows usage of subscripts directly on the object.
    • Asterisks
      • The * and ** operators in python can be used in several ways, including tuple unpacking, iterator unpacking into
    • Single Line if else
      • For example: value = <value_if_true> if <expression> else <value_if_else>
  • Packages and Tools
    • Useful packages and Python related tools such as pip, virtualenv, pipenv, conda.
    • Pendulum
      • Drop in replacement for datetime with cleaner API and better complex use-cases support.
    • SqlModel
      • Built on SQLAlchemy, provides ORM for Python. Works great with FastAPI.
    • Conda Install and Setup
      • See https://docs.conda.io/en/latest/miniconda.html for install link. Use miniconda as it doesn't download all packages

general.md

• General References
  • General notes and references that don't yet warrant a separate file.
  • Cheat Sheets
    • Shortcuts and syntax cheat sheets
    • Pycharm
      • Pycharm references
      • Pycharm Shortcuts
        • See pycharm keyboard shortcuts.
      • Pycharm Source Code Navigation
        • See pycharm source code navigation.
      • Pycharm Terminal PowerShell Execution Policy (Windows)
        • Run Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted in PowerShell
    • Vimium Shortcuts
      • See vimium shortcuts.
    • Markdown Cheat Sheet
      • See markdown cheat sheet.
  • General Issues
    • General issues and solutions
    • Monorepo Frontend+Backend Project Setup With Jetbrains IDEs
      • When prototyping Frontend+Backend projects, the backend might need to be placed in a subdirectory of the frontend, to

git.md

• GIT References
  • General info and references for git.
  • Move local repo to a fork after cloning
    • Steps for changing local repo from clone of remote repo to fork of repo.

frontend.md

• Frontend References
  • Javascript, Typescript, React, Next.JS references. For now, catch-all while I give myself a frontend
  • Envrionment Setup
    • Environment setup for frontend dev.
    • node.js and npm
      • Use nvm, a node version manager, to install node.
    • next.js and React
      • Use npm install next@latest react@latest react-dom@latest or npx create-next-app@latest for auto setup.
  • Getting Started
    • Getting started...
    • next.js boilerplate
      • See vercel nextjs template
    • Installing Prettier and Prettier Configuration
      • To add prettier to a project, run npm install prettier --save-dev
    • Tailwind CSS
      • Install prettier plugin for tailwind, to automatically sort tailwind classes.
    • Storybook and NextJS integration
      • When integrating Storybook with NextJS, may need to manually add the following to .storybook/main.js:
    • Vercel Serverless Functions
      • Note: Can't seem to use both Node and non-node serverless functions in the same project.
  • Libraries and Tools
    • Useful libraries and tools.
    • Authentication next-auth
      • See github and website

---