@storm-software/cloudflare-tools

Website • GitHub • Discord • Docs • Contact • Report a Bug

This package is part of the ⚡Storm-Ops monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.

💻 Visit stormsoftware.com to stay up to date with this developer

      

[!IMPORTANT] This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.

Be sure to ⭐ this repository on GitHub so you can keep up to date on any daily progress!

Table of Contents

• Storm Cloudflare Tools
  • Installing
  • Executors
  • cloudflare-publish
    • Example
  • serve
    • Example
  • r2-upload-publish
    • Example
  • Generators
  • init
  • worker
  • Building
  • Running unit tests
  • Storm Workspaces
  • Roadmap
  • Support
  • License
  • Changelog
  • Contributing
  • Contributors

Storm Cloudflare Tools

A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.

This library was generated with Nx.

Installing

Using pnpm:

pnpm add -D @storm-software/cloudflare-tools

Using npm

npm install -D @storm-software/cloudflare-tools

Using yarn

yarn add -D @storm-software/cloudflare-tools

Executors

The following executors are available in this package to invoke common tasks for the workspace's projects:

cloudflare-publish

Publish a Cloudflare worker/pages using the Wrangler CLI

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:cloudflare-publish

Please note: The cloudflare-publish executor should be included in the desired projects's project.json file.

serve

Serve a worker locally for development using the Wrangler CLI

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:serve

Please note: The serve executor should be included in the desired projects's project.json file.

r2-upload-publish

Publish changes by uploading files to a Cloudflare R2 bucket

Example

This executor can be used by executing the following in a command line utility:

nx run my-project:r2-upload-publish

Please note: The r2-upload-publish executor should be included in the desired projects's project.json file.

Generators

The following generators are available with this package to assist in workspace management:

init

Init Cloudflare tools Nx Plugin in the Storm Workspace

worker

Add a worker application project to the current Storm workspace

Building

Run nx build cloudflare-tools to build the library.

Running unit tests

Run nx test cloudflare-tools to execute the unit tests via Jest.

Storm Workspaces

Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.

[ Back to top ▲ ]

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

[ Back to top ▲ ]

Support

Reach out to the maintainer at one of the following places:

• Contact
• GitHub discussions
• [e-mail]

[ Back to top ▲ ]

License

This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.

See LICENSE for more information.

[ Back to top ▲ ]

Changelog

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file

[ Back to top ▲ ]

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

You can use markdownlint-cli to check for common markdown style inconsistency.

[ Back to top ▲ ]

Contributors

Thanks goes to these wonderful people (emoji key):

Patrick Sullivan 🎨 💻 🔧 📖 ⚠️	Tyler Benning 🎨	Stormie 🚧
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

[ Back to top ▲ ]

Website • Contact • LinkedIn • Medium • GitHub • OpenPGP Key

Fingerprint: F47F 1853 BCAD DE9B 42C8 6316 9FDE EC95 47FE D106

Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.

Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.

Join us on Discord to chat with the team, receive release notifications, ask questions, and get involved.

If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website or join our Slack channel!

[ Back to top ▲ ]