ConduitPlatform / Conduit

Batteries-included backend that works with any stack.

Home Page:https://getconduit.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo


CodeFactor Badge Latest SemVer Release Commit Activity Discord Server

Conduit is a self-hosted backend aiming to cut down development times by providing common functionality through ready-made modules, while offering maximum flexibility through extensions and custom modules.

Why write and debug the same boilerplate code for every project when you can focus on implementing the features that genuinely matter for your unique application.
Conduit takes care of all the tedious tasks that come with developing a backend from scratch, allowing you to spend your time building APIs that are going to properly support your project's needs and make it stand out.

Conduit is made with ❤️ by Quintessential SFT in Athens🇬🇷.

Getting Started ✨

We built a CLI to help you conveniently spin up local Conduit deployments among other interesting things.

# Install Conduit CLI and setup a local deployment:
sh <(curl -s https://getconduit.dev/bootstrap)

👉 Make sure Docker and Docker Compose are available. 👈

⚠️ Windows users are currently expected to use the CLI through WSL. ⚠️

Once your deployment is ready, your web browser will automatically redirect you to your administration dashboard.
Depending on your environment, it may take a few seconds for the page to become responsive.

Default Credentials: admin/admin.
Once logged-in, you may check out your APIs' generated route documentation through the Swagger and GraphQL elements.

Find out more regarding Conduit's CLI

Documentation 📖

If you're only just starting out with Conduit, make sure you familiarize yourself with the project by checking out our docs.

Can't find what you're interested in? Shoot us a message on Discord and we'll help you out.

Modules 🧩

  • Authentication - Authenticate your users using a plethora of sign-in methods.
  • Authorization - Configure resource authorization rules that meet your needs.
  • Chat - Build realtime chat applications.
  • Database - Create schemas with auto-generated CRUD and Query-based functional endpoints. Supports MongoDB and PostgreSQL.
  • Email - Send emails using multiple supported providers.
  • Forms - Submit forms and have responses forwarded to an email address.
  • PushNotifications - Send push notifications to your users.
  • Router - Seamlessly expose REST, GraphQL and WebSockets APIs with auto-generated endpoint documentation.
  • SMS - Send text messages and expand user authentication with 2FA.
  • Storage - Online storage using multiple cloud providers.

Running from Source 🔨

Find out how to build and run Conduit from source in the Development Setup section.

Roadmap 🏁

Wanna see what comes next? Here's some of the stuff we're working on behind the scenes.

Contributing ❤️

We built Conduit cause we felt like none of the already available options seemed right for our needs.
Then we made it open-source so that everyone can use and extend it however they see fit.

If you enjoy building awesome things and want to support the project, check out our Contributing Guide to find out how to get started.

About

Batteries-included backend that works with any stack.

https://getconduit.dev

License:MIT License


Languages

Language:TypeScript 97.4%Language:JavaScript 1.4%Language:Shell 0.7%Language:Dockerfile 0.4%Language:Makefile 0.1%Language:Ruby 0.0%