@scramjet/model
    TypeScript icon, indicating that this package has built-in type declarations

    0.12.2 • Public • Published

    @scramjet/model

    The package provides the domain model for Scramjet Transform Hub, the API Client and CLI.

    Docs

    See the code documentation here: scramjetorg/transform-hub/docs/model/README.md

    Scramjet Transform Hub

    This package is part of Scramjet Transform Hub.

    Scramjet Transform Hub is a deployment and execution platform. Once installed on a server, it will allow you to start your programs and keep them running on a remote machine. You will be able to start programs in the background or connect to them and see their output directly on your terminal. You will be able to pipe your local data to the program as if it was running from your terminal. You can start your server in AWS, Google Cloud or Azure, start it on your local machine, install it on a Rasperry Pi or wherever else you'd like.

    Use cases

    There's no limit what you can use it for. You want a stock checker? A chat bot? Maybe you'd like to automate your home? Retrieve sensor data? Maybe you have a lot of data and want to transfer and wrangle it? You have a database of cities and you'd like to enrich your data? You do machine learning and you want to train your set while the data is fetched in real time? Hey, you want to use it for something else and ask us if that's a good use? Ask us via email or hop on our Scramjet Slack!

    Some important links

    License and contributions

    This module is licensed under AGPL-3.0 license.

    The Scramjet Transform Hub project is licensed dual licensed under the AGPL-3.0 and MIT licences. Parts of the project that are linked with your programs are MIT licensed, the rest is AGPL.

    Contributions

    We accept valid contributions and we will be publishing a more specific project roadmap so contributors can propose features and also help us implement them. We kindly ask you that contributed commits are Signed-Off git commit --sign-off.

    We provide support for contributors via test cases. If you expect a certain type of workflow to be officially supported, please specify and implement a test case in Gherkin format in bdd directory and include it in your pull request.

    Help wanted

    The project need's your help! There's lots of work to do and we have a lot of plans. If you want to help and be part of the Scramjet team, please reach out to us, on slack or email us: opensource@scramjet.org.

    Donation

    Do you like this project? It helped you to reduce time spent on delivering your solution? You are welcome to buy us a coffee ;)

    You can sponsor us on github

    • There's also a Paypal donation link if you prefer that: paypal

    Keywords

    none

    Install

    npm i @scramjet/model

    DownloadsWeekly Downloads

    1

    Version

    0.12.2

    License

    AGPL-3.0

    Unpacked Size

    74.1 kB

    Total Files

    39

    Last publish

    Collaborators

    • scramjetorg
    • michalcz
    • stoq