CodeMelted DEV Project

The following document will help you setup this repo for local development utilizing PowerShell Core, VS Code, and the installation of the necessary tools to support the build.ps1 script.

Hope you enjoy the content. Any support is greatly appreciated. Thank you! 🙇

Table of Contents

• Environment Setup
  • GitHub
  • Programming Languages
  • NeoVim
  • VS Code
• Repo Structure
  • build.ps1 Script
  • Module Directories

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

• Deno
• Flutter
• NodeJS
• PowerShell Core
• Rust

NeoVim

TBD

VS Code

The Application:

• VS Code

Extensions:

• Code Spell Checker
• Dart
• Deno
• Docker
• ESLint
• Flutter
• Markdown All in One
• Markdown Preview Mermaid Support
• PowerShell
• Rust

Repo Structure

build.ps1 Script

The build.ps1 --build script provides the ability to build, test, and document the codemelted_developer repo modules. The build.ps1 --deploy deploys the CodeMelted DEV website. The build.ps1 --test will test any changes to the repo modules.

Module Directories

The following are the individual source module project folders. They are setup to work with both the CLI tools of that particular language SDK and the build.ps1 script. For an understanding what these modules are about see the design-notes.drawio.html file or the individual README.md file of each project.

• codemelted_dev: An mdbook project documenting what the CodeMelted DEV Project is all about.
• codemelted_flutter: The development of the codemelted.dart module and supporting project definitions for targeting Flutter Web targets. Supports both SDK deployment to the codemelted.com domain and pub.dev for discoverability by flutter developers.
• codemelted_js: The development of the codemelted.js ES6 module for usage in Deno, NodeJS, and static Web page deployments. Supports SDK deployment to the codemelted.com domain with support via the codemelted CLI when starting new web projects.
• codemelted_pi: An mdbook project documenting the CodeMelted PI project. It will contain all the design artifacts and instructions for how to setup such a system for photography fun.
• codemelted_pwsh: An mdbook project documenting the codemelted.ps1 module that represents the codemelted CLI. Supports both SDK deployment to the codemelted.com domain and the Microsoft PSGallery for script installation.
• codemelted_rust: The development of the codemelted.rs cargo project to support native app / service development. Supports both SDK deployment to the codemelted.com domain and the crates.io Rust repository.
• index.html: Static page for the codemelted.com/developer domain to access the above SDK documents.