CodeMelted - Developer

"Write once, run anywhere (WORA)" was the famous slogan made by Sun Microsystems in 1995. At the time, this technology allowed for easy full stack engineering allowing you to target dedicated workstations and on premise servers. So long as a Java Runtime Environment existed, you could run your code. Java was unable to keep to their slogan as web browsers became more advanced, mobile devices became ubiquitous, and companies no longer required dedicated servers.

Software engineers are now required to learn multiple languages, technologies, and frameworks in order to fully support full stack engineering. This project aims to simplify by developing a set of cross platform modules implementing a similar / identical Application Program Interface (API) regardless of the chosen technology covered by this project. This allows a developer to maximize their productivity because regardless of the technology, they are learning a similar module API for their solution.

Table of Contents

FEATURES
GETTING STARTED
USAGE
- Cross Platform Modules
- CodeMelted Pi Project
LICENSE

FEATURES

---
title: Use Case Model
---
flowchart TD
    subgraph ucModel[Use Cases]
        subgraph Core
            ucDataBroker([Data Broker])
            ucFetch([Fetch])
            ucLinkOpener([Link Opener])
            ucLogger([Logger])
            ucMath([Math])
            ucRuntime([Runtime])
            ucShare([Share])
            ucStorage([Storage])
        end
        subgraph User Interface
            ucAppView([App View])
            ucConsole([Console])
            ucDialog([Dialog])
            ucThemes([Themes])
            ucWidgets([Widgets])
        end
        subgraph Advanced
            ucAsyncIO([Async IO])
            ucAudioPlayer([Audio Player])
            ucDatabase([Database])
            ucDeviceOrientation([Device Orientation])
            ucDiskManager([Disk Manager])
            ucHardwarePeripheral([Hardware Peripheral])
            ucNetworkSocket([Network Socket])
            ucWebRTC([Web RTC])
        end
    end
    subgraph sdk[SDK]
        pwsh[[pwsh]]
        javascript[[javascript]]
        flutter[[flutter]]
    end
    subgraph os[Operating System]
        app[[app]]
        disk[(disk)]
        network((network))
        display{{display}}
        hardware[\hardware/]
    end
    Developer--Develops With-->ucModel
    ucModel--Implemented In-->sdk
    sdk--Targets-->app
    app--Accesses-->disk
    app--Accesses-->network
    app--Accesses-->display
    app--Accesses-->hardware
    appUser[App User]--Uses-->app

Core

The core set of use cases represent the most common actions you will carry out when developing an application.

Data Broker: JSON (JavaScript Object Notation) is a lightweight data-interchange format. Unlike XML (Extensible Markup Language), it is universal for data transport, manipulation, and representing complex data structures. This use case will expose functions for working / validating this set of datasets.
Fetch: REST, or REpresentational State Transfer, is an architectural style for providing standards between computer systems on the web, making it easier for systems to communicate with each other. This is the most basic way of getting data between a backend server and a client application. This use case will implement this capability.
Link Opener: A different set of protocols (a.k.a. file, http, sms, etc.) can be opened via a set of desktop services exposed via the host system of your application. This use case will wrap these desktop services allowing you to open the host service for the given protocol.
Logger: Logging is the most basic way of either debugging your application or relaying information to your user base. This use case will provide a logging service for this purpose.
Math: All applications will have to exercise mathematical computations. This use case will setup a collection of of these mathematical formulas easily accessible for usage within an application.
Runtime: The runtime represents specific functionality to a specific language SDK. This use case will provide common properties common to all these SDKs. The use case will also expose functions that are specific to the given SDK.
Share: In line with the Link Opener use case, most host systems also provide the ability to share information via a host service. This use case will expose this functionality.
Storage: The ability to store key / value pairs into storage is a easy simple way to quickly access information for an application. In combination with the Data Broker use case working with JSON data, this use case will provide the developer quick access to this storage concept.

User Interface

The user interface set of use cases solidifies the ability to have a standard set of actions to interact with your user without limiting you from utilizing the options available in a given SDK module.

App View: An SPA (Single-page application) is an app implementation that loads only a single view, and then updates the body content of that single document view. This use case will provide this singular view concept regardless of the underlying UI architecture.
Console: Command Line Interface (CLI) tools are common via the terminal of most backend systems. This use case will expose functions for exploiting this type of interface.
Dialog: Most SDKs provide basic popup dialogs for interacting with users to either gather information or provide user's information. This use case will provide a set of common dialogs for the given SDK to interact with the user. It will also allow for building complex dialogs for user interactions via the App View use case.
Themes: Each SDK environment provide the ability to theme the Widget use case components of user interface. This use case will setup a common ability setup the look and feel of the user interface experience.
Widgets: Each SDK has a rich set of widget components. This use case will setup a common set of these widget components while not limiting the developer's ability to utilize other widget components of the SDK.

Advanced

The advanced set of use cases offer more complex actions a developer may need to carry out in their application. This aims to simplify the complexity of the given actions.

Async IO: All programming happens synchronously (i.e. one instruction to the next). This occurs within the event loop of the main SDK execution thread. This use case will provide the ability to chunk work within this main event loop along with scheduling work within a background event loop thread.
Audio Player: Host systems provide the ability to either play audio files or translate a string into text-to-speech. This use case will expose this host processing to the developer.
Database: Databases provide the ability of storing complex data structures. The two main concepts for this is either relational database structures (SQL) or no-SQL indexed databases. These are available depending on the SDK environment. This use case will expose the ability to access these services for the given SDK.
Device Orientation: Geospatial relates to or denoting data that is associated with a particular location. This use case will expose the ability of access your application in this 3D space orientation and GPS location on the Earth.
Disk Manager: Applications have access to hard disk which houses directories, files, and other information. This use case will expose the ability to manage the disk along with interface with said files from the disk.
Hardware Peripheral: Systems have the ability to interface with external hardware that connect via different protocols. This use case will expose these different protocols for exchanging information with these connected devices.
Network Socket: The Open Systems Interconnection (OSI) model describes seven layers that computer systems use to communicate over a network. It was the first standard model for network communications, adopted by all major computer and telecommunication companies in the early 1980s. Sockets and network protocols provide the means to communicate between client / server applications. This use case will expose these different network protocols to allow for application inter-communication over a network.
Web RTC: With WebRTC, you can add real-time communication capabilities to your application that works on top of an open standard. It supports video, voice, and generic data to be sent between peers, allowing developers to build powerful voice- and video-communication solutions. This use case will provide modules the ability to utilize this technology for user communication.

GETTING STARTED

The Getting Started documents setup and utilize this repo once clone.

USAGE

Cross Platform Modules

The following are the cross platform modules implementing the identified use cases of this project. It provides several choices for your development needs. The following links take you to the specific module implementations for your given domain.

Flutter Module: This project aims to provide a developer with the ability to build client applications regardless of deployment target. Those deployment targets include desktop, mobile, and web. By leveraging the CodeMelted - Developer identified use cases, you can be assured to building a powerful native application.
JS Module: This project aims to give a common fullstack solution for Progressive Web Applications (PWA) utilizing the CodeMelted - Developer use cases. It utilizes the Deno Runtime to run as your backend service. This was chosen as it has a full range of services for your backend if you choose to utilize it. You can also take your backend and host it on a different platform. This allows you to not be locked into a vendor for your backend. It was also chosen because it implements the Browser Web APIs. This allows the module to implement backend and web frontend common code developing a more complete solution. Lastly, Deno provides the use of TypeScript natively out of the box. So you are able to utilize both JavaScript / TypeScript for your solution and roll with any build system.
pwsh Module: This project aims to implement CodeMelted - Developer use cases with the terminal in mind. The terminal serves as the place developers string together Dev OPS or automated solutions to users. With this in mind, PowerShell Core was chosen as the target platform. The reason for this is it has full support for Linux, Mac, and Windows allowing for a common scripting language regardless of the operating system.

CodeMelted Pi Project

CodeMelted Pi Project: This project aims to utilize the different CodeMelted - Developer modules as services on a Raspberry Pi. These services aim to allow a user to yield different configurations to utilize the Raspberry Pi. The identified services will include getting GPS coordinates, taking still frame pictures tagged with the GPS information, taking video to serve as a dash cam or web camera, provide infotainment within a vehicle, the ability to interface with the raspberry pi via the Internet, and finally, as a sky watching camera for nighttime astronomy.

LICENSE

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

CodeMelted/codemelted_developer