Falkor Framework Knowledge Base

Audience

Targeted audience of the document is primarily visual developers and quality assurance members, but anyone interested in the operation of the Falkor Framework under the hood can benefit from the content. While many topics are covered, most of them expect the reader to have basic understanding of their respective fields.

Scope

The document will discuss in-depth technical details regarding the development of the Falkor Framework, and will also cover tools and techniques used everyday by developers and quality assurance members.

Table of Contents

1. Development
   1. Prerequisites
      1. Software
      2. Tools
   2. Version Control
   3. Environment Setup
      1. VSCode
   4. Project Structure
      1. Abstract
      2. Submodule Structure
      3. Workspace Structure
      4. Dependency Resolution
   5. Code Quality Tools
      1. Prettier
      2. ESLint
      3. CSpell
      4. Other Tools
   6. Build System
   7. Release Management
2. Appendix
   1. Terminal Cheat Sheet
      1. Bash to PowerShell
   2. Git Cheat Sheet
      1. Basic Workflow
      2. Scenarios
   3. Markdown Cheat Sheet
      1. Syntax
      2. Lists
      3. Tables
      4. Heading ID Generation
   4. NPM Cheat Sheet
      1. Versioning
      2. Node Executables
      3. Configuration
      4. Registries
   5. VSCode Tips & Tricks
      1. Tasks
      2. Launch Configurations
      3. Recommended Extensions
   6. Links
      1. Watching
      2. Reading
      3. Repositories

---

©2020-2023 Barnabas Bucsy - All rights reserved.