Skip to content
forked from asyncapi/glee

Glee — The AsyncAPI framework that will make you smile again :)

Notifications You must be signed in to change notification settings

Maniktherana/glee

 
 

Repository files navigation

Glee — The AsyncAPI framework that will make you smile again.

All Contributors

Coverage Status

⚠️ Glee is still under development, it didn't reach v1.0.0 and therefore is not suitable for production use yet.

⚠️ So far, it only supports MQTT and WebSockets (native, Socket.IO, and custom implementations).

What's Glee?

Glee is a spec-first framework that helps you build server-side applications. It leverages the AsyncAPI specification to make you more productive:

  • It makes sure your code and AsyncAPI definition are on par. No more outdated documentation. Glee takes care of it for you, automatically.
  • Glee lets you focus on what matters and handles the rest for you. You only write the code for your business use-case. Glee takes care of performance, scalability, resilience, and everything you need to make your application production-ready.

Setup

The best way to get started with Glee is using create-glee-app, which sets up everything automatically for you. To create a project, run:

npx create-glee-app

After the installation is complete, follow the instructions to start the development server.

For more information on how to use create-glee-app, you can review the create-glee-app documentation.

Getting started

Generating documentation

When using spec-driven framework like Glee, it's always neccessary to have docs and code always in sync. Glee will automatically generate documentation for your application and you can also generate your documentation yourself by running:

glee docs

You can also tweak Glee's default configuration for generating documentation here Configuring your application

Contributors ✨

Thanks goes to these wonderful people (emoji key):


sudoshreyansh

⚠️

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

About

Glee — The AsyncAPI framework that will make you smile again :)

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.6%
  • JavaScript 1.4%