Skip to content

cyclopt/Conduit

 
 

Repository files navigation

lerna

Conduit Platform

Conduit is a NodeJS-based Backend as a Server, that aims to cut down development times by providing ready-made modules that offer common functionality out of the box, and allowing maximum flexibility to add custom functionality.

Features ✔️

  • Transports: REST, GraphQL, WebSockets (via Socket.io) and gRPC
  • Database support for MongoDB and PostgreSQL (alpha)
  • In-memory database through Redis
  • All functionalities and routes available both as REST and GraphQL endpoints
  • CMS module to create and edit schemas from the admin panel and also add custom logic through the "custom endpoints" functionality
  • Swagger docs and GraphQL explorer with full route documentation
  • Authentication system with JWT and 2FA, supporting ServiceAccounts/API keys as well as local(username/password or email/password), oAuth(Facebook, Google, Twitch)
  • Basic security built-in with Client Id/secret for all requests, rate limiting and Helmet.
  • Emails with template support
  • SMS for 2FA or plain SMS send
  • Storage using either GCS or Azure Blob Storage (S3 coming soon)
  • Chat
  • Forms for basic form submission and email forwarding
  • Conduit SDK can be used to add new modules or custom services
  • so much more

Requirements ⚡

  • NodeJS > 14
  • MongoDB or PostgreSQL
  • Desire to create something awesome

Running 🔨

yarn
npx lerna run build
REDIS_HOST=localhost REDIS_PORT=6379 yarn --cwd ./packages/core start
CONDUIT_SERVER=0.0.0.0:55152 SERVICE_IP=0.0.0.0:55165 yarn --cwd ./modules/database start

Then repeat the last step for every additional module you need to bring online.

CONDUIT_SERVER=0.0.0.0:55152 SERVICE_IP=0.0.0.0:PORT yarn --cwd ./modules/MODULE start

Environment Variables 📃

Core:

Variable Description Required Example
REDIS_HOST Redis address True localhost
REDIS_PORT Redis port True 6379

Database

Variable Description Required Example Default
databaseURL database URL False localhost mongodb://localhost:27017
databaseType db engine type False sql mongodb

Generic module env variables are also supported, with required ones being obligatory.

General Module

Variable Description Required Example
CONDUIT_SERVER Conduit Core's address and port True 0.0.0.0:55152
SERVICE_IP Always 0.0.0.0 and a port numer True 0.0.0.0:55190
SERVICE_URL Deprecated in v0.11, same as SERVICE_IP True 0.0.0.0:55190
REGISTER_NAME Set to true if running in Kubernetes False true

Information ℹ️

  • Core HTTP Server runs at: http://localhost:3000
  • Core Grpc Server runs at: localhost:55152
  • Core Socket Server runs at: localhost:3001

Roadmap 🏁

  • Payments module to facilitate payments with Stripe, BrainTree etc
  • Custom workflows with "Actor"
  • Optimization

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.5%
  • Other 1.5%