Skip to content

lowdefy/lowdefy

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Lowdefy

Discord

Tweet Follow

Tests Maintainability Test Coverage Codecov

Lowdefy 🫶 The Easiest Config Webstack on top of Next.js

Lowdefy is an open-source web framework that enables you to:

  • 🎨 Build web UIs and connect to databases and APIs.
  • 🔌 Extend app functionality with npm plugins.
  • ⚛️ Built on top of Next.js and Auth.js.
  • 🌐 Host your apps anywhere you host Next.js.
  • ✂️ Only code your business logic.

Create internal tools, web apps, admin panels, BI dashboards, web sites and CRUD apps with simple YAML or JSON config.

🛠 Build Web UIs with Easy Config

Lowdefy config is easy to read, write, copy, paste, or template. Config when you can, but code when you need to.

  • Over 70 Blocks and 150 logic operators for a quick start.
  • Dynamic UIs with simple state management.
  • Responsive layouts out of the box.
  • Extend with custom React components.

📡 Connect to Your Data and APIs

Make API calls and read and write to your databases with minimal config. Build web apps that connect your data.

  • Build dynamic queries using variables and logic operators.
  • Execute requests from both authenticated and public pages.
  • Secure secrets for passwords and API keys.
  • Build custom connections with any npm modules.

🔓 Open-Source Framework with No Lock-In

Lowdefy is an open-source framework built on top of Next.js. Lowdefy allows you to build future-proof apps, host them anywhere, and avoid vendor lock-in.

🔧 Extend Everything with NPM Plugins

Lowdefy's Blocks, Requests, Operators, Actions, Auth Providers, and Adapters can all be extended with plugins, making it the most flexible config web stack. Powered by NPM, Lowdefy's plugin system allows developers to bundle modules using their preferred packages. Even unpublished plugins can be added to your repository, enabling easy use of project-specific code. See the plugin docs and the plugin project example for more details.

💼 Built for Developers and Enterprise-Ready

🌍 Deploy Anywhere

Lowdefy runs as a Next.js app in production, so you can deploy it anywhere that supports Next.js deployment. Deploy with Vercel, Docker, or anything that runs Next.js apps.

🔒 Secured with Auth.js

Authentication is built on top of Auth.js, providing the full flexibility and security from one of the most popular open-source auth layers. SSO, SAML, 2FA, no problem. Google, Okta, Auth0, and more - bring your own provider.

👩‍💻👨‍💻 Git Control for Humans

Lowdefy's minimal config is designed to be easy to read, write, and understand, making it simple to copy, paste, review changes, or pick up where others left off. Defining apps using a structured schema speeds up development in teams of any size.

🔑 Public, Authenticated, and Role-Based Access

Lowdefy supports building multi-page apps with both public and private pages, serving a wide range of use cases. Role-based access control (RBAC) allows for easy implementation of secure, granular access control where needed.

How Lowdefy Apps Work 👉 https://docs.lowdefy.com

Lowdefy apps are built using:

  • 📦 Blocks are the visual part of the app, the React components. Lowdefy provides a set of default block types but app capabilities can be extended with custom blocks.
  • ⚙️ Operators are the functions that are used to express logic within an app. Lowdefy has many built in easy to use operator functions for creating dynamic applications with ease, however, custom javascript operators can also be loaded.
  • ⚡️ Actions are triggered by events, like clicking a button or loading a page. When events are triggered, a list of javascript functions can be called. Lowdefy has a set of useful actions, but applications functionality can be enriched by adding custom Lowdefy actions.
  • 📣 Requests make calls to external services to hydrate applications with data or post data to external services. Lowdefy doesn't have any data storage built in. Instead, it provides connections to external services like databases and APIs.

We are working on expanding the list of connections, and you can vote for the ones you need here.

Quick start

Run:

pnpx lowdefy@latest init && pnpx lowdefy@latest dev

This will create a file called lowdefy.yaml in the current working directory that contains the configuration for a Lowdefy app (as well as a .gitignore) and launch a local development server at http://localhost:3000. Make changes in the lowdefy.yaml file to see them reflect in the app.

🔗 More Lowdefy Links

⛹️‍♀️ Contributing

Lowdefy Plugins

The simplest way to contribute to Lowdefy is by creating custom plugins like Blocks, Actions, Requests, Operators, or Auth Adapters and Providers, and publishing them to NPM for the community's benefit.

Easily add and develop plugins in any Lowdefy project; refer to the plugins project example for a pnpm monorepo setup to jumpstart local plugin development.

When publishing your plugin to NPM, include lowdefy in the name for easy discovery, and share it on our Github Discussions to inform the community.

Lowdefy Platform Development

Run Lowdefy servers locally by adding your Lowdefy config to the app/.. folder. Use one of the following scripts to the server:

  • pnpm app:cli:dev: Starts the development server with the config provided in the app folder, useful for developing locally.
  • pnpm app:cli:build: Creates a production build of your lowdefy app for the config config provided in the app folder.
  • pnpm app:cli:start: Starts the production server of your lowdefy app built using the build command output.

See the project package.json scripts for more predefined scripts.

Please also see CONTRIBUTING.md.

☕️ Changelog

Convert a v3 app to V4 - See the v4 conversion notes.

All changes to this project are documented in CHANGELOG.md.

🔐 Security

If you discover a vulnerability, please follow the guide in SECURITY.md to disclose this to us responsibly.

🤝 Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to follow the Contributor Covenant code of conduct. See CODE_OF_CONDUCT.md for more.

⚖️ Licence

Apache-2.0