Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intales/gazelle
Lightweight Dart HTTP server framework for modular web development. Build APIs with speed and simplicity.
https://github.com/intales/gazelle
api backend dart easy-to-use fast plugin scalable
Last synced: about 7 hours ago
JSON representation
Lightweight Dart HTTP server framework for modular web development. Build APIs with speed and simplicity.
- Host: GitHub
- URL: https://github.com/intales/gazelle
- Owner: intales
- License: bsd-3-clause
- Created: 2024-01-15T18:16:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-06T11:01:50.000Z (2 months ago)
- Last Synced: 2024-09-08T10:34:38.121Z (2 months ago)
- Topics: api, backend, dart, easy-to-use, fast, plugin, scalable
- Language: Dart
- Homepage: https://docs.gazelle-dart.dev
- Size: 1.81 MB
- Stars: 36
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Gazelle
Gazelle is a lightweight and flexible HTTP server framework for Dart,
designed to streamline the development of web applications with ease.
With Gazelle, you can quickly set up powerful APIs, web servers, and
microservices, all with minimal configuration and maximum efficiency.
## Features
- **Easy-to-Use**: Gazelle is built with simplicity in mind.
Whether you're a seasoned developer or just starting out, Gazelle's intuitive
API and clear documentation make it easy to get up and running in no time.
- **Plugin System**: Extend Gazelle's functionality with custom plugins.
Seamlessly integrate authentication, logging, and other common features into
your application with Gazelle's plugin architecture.
- **Middleware Support**: Gazelle supports middleware functions, allowing you to
customize request handling with ease.
Add authentication, rate limiting, and more to your routes with just a
few lines of code.
- **HTTP/HTTPS Support**: Gazelle fully supports both HTTP and HTTPS protocols,
ensuring secure communication for your applications.
Easily configure SSL certificates for added security.
## Getting started
### Installation
To start using Gazelle in your Dart project, simply add it to your `pubspec.yaml` file:
```yaml
dependencies:
gazelle_core:
```
Then, run `dart pub get` or `flutter pub get` to install the package.
### Example usage
Here's a quick example of how to create a simple Gazelle server:
```dart
import 'package:gazelle_core/gazelle_core.dart';
void main() async {
final app = GazelleApp(
routes: [
GazelleRoute(
name: "hello_gazelle",
get: (context, request, response) => GazelleResponse(
statusCode: GazelleHttpStatusCode.success.ok_200,
body: "Hello, Gazelle!",
),
),
],
);
await app.start();
print("Gazelle listening at ${app.serverAddress}");
}
```
That's it! You've just created a basic Gazelle server that responds with "Hello, Gazelle!"
to any incoming requests to the root route.
To learn more, check out our [documentation](https://docs.gazelle-dart.dev/).
## Contributing
At Gazelle, we believe in the power of community collaboration.
Our plugin system not only helps scale your codebase but also empowers developers to
contribute to the community without relying solely on the core maintainers.
Whether you're interested in fixing bugs, adding new features, improving documentation, or leaving a feedback,
your contributions are welcome and valued.
We encourage you to get involved by opening issues, submitting pull requests,
or joining discussions on our GitHub repository.
Together, we can make Gazelle even better for everyone.