CodeMelted - Getting Started

Table of Contents

• Environment Setup
  • GitHub
  • Programming Languages
  • VS Code
• Module Versioning
• Build Script

Environment Setup

The following are the items recommended for installation to properly make use of this repo in your development environment.

GitHub

• git
• GitHub Desktop

Programming Languages

• C/C++
• Deno
• Flutter
• PowerShell Core

VS Code

The Application:

• VS Code

Extensions:

• C/C++ Extension Pack
• Code Spell Checker
• Dart
• Deno
• Docker
• ESLint
• Flutter
• Markdown All in One
• Markdown Preview Mermaid Support
• PowerShell
• Python
• WSL

Module Versioning

The versioning of the module will be captured via GitHub or the modules documentation method. It will utilize semantic versioning X.Y.Z with the following rules for the numbering scheme this project.

• X: Completion of either Core / User Interface / Advance set of use cases.
• Y: Use case implemented, documented, tested, and ready for usage by a developer.
• Z: Bug fix or expansion of a use case.

Build Script

The build.ps1 script provides the ability to build different elements of this project. Execute the command option below from the root of the codemelted_developer repo to get the specified result.

• ./build.ps1 --cdn: Builds all the other options to a _dist directory allowing for a severable static website.
• ./build.ps1 --codemelted_flutter: Compiles the module and generates its SDK documentation.
• ./build.ps1 --codemelted_js: Compiles the module to serve from a website and generates its SDK documentation.
• ./build.ps1 --codemelted_pwsh: Compiles the PowerShell module to be installed on your system and generates its SDK documentation.
• ./build.ps1 --codemelted_pi: Generates a static website of the raspberry pi index.html and supporting markdown files.