Skip to content

Latest commit

 

History

History

language

Acidic


🧪 Acidic is a modeling tool that can be used to describe and generate code for API end points, database tables, type definitions, client components, and so much more!

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.

💻 Visit acidic.io to stay up to date with this developer


Version  Nx NextJs Commitizen friendly Semantic-Release documented with docusaurus GitHub Workflow Status (with event)

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 availible 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.


Acidic Language Definition

The 🧪 Acidic Language Definition is used to outline the schemas for your business models and generate static code based on those models. This language definition is used by the Acidic Engine to provide support for other Acidic tools (CLI, Nx Plugins, etc.). Included is the specification of the syntax and semantics of Acidic.

JSON Schema

This package contains a JSON Schema v7 definition for the Acidic language. This is not used by the Acidic Language Server, but is provided for use by other tools that may need to validate Acidic files.

Reduced Package Size

This project uses tsup to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.

Development

This project is built using Nx. As a result, many of the usual commands are available to assist in development.

Building

Run nx build language to build the library.

Running unit tests

Run nx test language to execute the unit tests via Jest.

Linting

Run nx lint language to run ESLint on the package.

Quick Features

Some of the features of Acidic include the following:

  • Describe your whole service in a single model, but allow for fined grained control (database structure, Api requests/response, validations, auth, etc.)
  • Generate code for your entire service from a single model
  • Visual Studio Code extension
  • CLI tools to drive processing
  • Nx plugins for an improved development experience

Model-Driven Development

Acidic refers to a collection of applications and libraries that are used to build server-side code from a user-defined model. The specification for this language can be found in the monorepo's language package.

Acidic Engine flow

More information can be found in the 📓 Acidic Documentation.

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.

Roadmap

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

Support

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

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.

Changelog

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

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.

Contributors

Thanks goes to these wonderful people (emoji key):

Patrick Sullivan
Patrick Sullivan

🎨 💻 🔧 📖 ⚠️
Tyler Benning
Tyler Benning

🎨
Stormie
Stormie

🚧
all-contributors logo Add your contributions

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



Storm Software

Fingerprint: 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D


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.

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!

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