https://github.com/asyncapi/glee
Glee — The AsyncAPI framework that will make you smile again :)
https://github.com/asyncapi/glee
get-global-docs-autoupdate get-global-node-release-workflows get-global-releaserc hacktoberfest nodejs
Last synced: 12 months ago
JSON representation
Glee — The AsyncAPI framework that will make you smile again :)
- Host: GitHub
- URL: https://github.com/asyncapi/glee
- Owner: asyncapi
- Created: 2021-05-30T14:30:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:20:16.000Z (over 1 year ago)
- Last Synced: 2024-10-29T12:16:14.360Z (over 1 year ago)
- Topics: get-global-docs-autoupdate, get-global-node-release-workflows, get-global-releaserc, hacktoberfest, nodejs
- Language: HTML
- Homepage:
- Size: 20.6 MB
- Stars: 89
- Watchers: 10
- Forks: 62
- Open Issues: 19
-
Metadata Files:
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](#contributors-)
[](https://coveralls.io/github/asyncapi/glee?branch=master)
## 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 by using [AsyncAPI CLI](https://github.com/asyncapi/cli), which sets up everything automatically for you. To create a project, run:
```bash
asyncapi new glee
```
After the installation is complete, follow the instructions to start the development server.
> For more information on how to install AsyncAPI CLI, you can review [CLI installation documentation](https://www.asyncapi.com/docs/tools/cli/installation)
## Getting started
* :file_folder: [Application structure](docs/app-structure.md): know how to structure your application with Glee.
* :gear: [Configuring your application](docs/config-file.md): tweak Glee's default configuration.
* :rocket: [Examples](./examples): see Glee in action.
## Generating documentation
When using spec-driven framework like Glee, it's always necessary to have docs and code always in sync.
Glee will automatically generate documentation for your application or you can also generate your documentation yourself by running:
```bash
glee docs
```
You can also tweak Glee's default configuration for generating documentation here: [Configuring your application](docs/config-file.md)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
sudoshreyansh
⚠️
Afzal Ansari
📖
Khuda Dad Nomani
💻
Godwin Alexander
📖 💻
Vivek Kumar
💻
Akhil Jamwal
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind is welcome!