Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codekeyz/pharaoh
Minimalist web-server library for Dart
https://github.com/codekeyz/pharaoh
backend dart expressjs flutter package router shelf
Last synced: about 1 month ago
JSON representation
Minimalist web-server library for Dart
- Host: GitHub
- URL: https://github.com/codekeyz/pharaoh
- Owner: codekeyz
- License: mit
- Created: 2023-11-09T00:58:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-05T23:35:45.000Z (9 months ago)
- Last Synced: 2024-04-24T08:05:23.040Z (8 months ago)
- Topics: backend, dart, expressjs, flutter, package, router, shelf
- Language: Dart
- Homepage: https://pub.dev/packages/pharaoh
- Size: 402 KB
- Stars: 127
- Watchers: 2
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - codekeyz/pharaoh - Minimalist web-server library for Dart (Dart)
README
# Pharaoh 🏇
[](https://github.com/codekeyz/pharaoh/actions/workflows/test.yml)
[](https://codecov.io/gh/codekeyz/pharaoh)
[](https://pub.dev/packages/pharaoh)
[](https://pub.dev/packages/pharaoh/score)
[](https://pub.dev/packages/pharaoh/score)
[](https://github.com/invertase/melos)
## Features
- Robust routing
- Focus on high performance
- Super-high test coverage
- HTTP helpers (just like ExpressJS)
- Interoperability with Shelf Middlewares [See here](./packages/pharaoh/SHELF_INTEROP.md)
## Installing:
In your pubspec.yaml
```yaml
dependencies:
pharaoh: ^0.0.6 # requires Dart => ^3.0.0
```
## Basic Usage:
```dart
import 'package:pharaoh/pharaoh.dart';
final app = Pharaoh();
void main() async {
app.use((req, res, next) {
/// do something here
next();
});
app.get('/foo', (req, res) => res.ok("bar"));
final guestRouter = app.router()
..get('/user', (req, res) => res.ok("Hello World"))
..post('/post', (req, res) => res.json({"mee": "moo"}))
..put('/put', (req, res) => res.json({"pookey": "reyrey"}));
app.group('/guest', guestRouter);
await app.listen(); // port => 3000
}
```
See the [Pharaoh Examples](./pharaoh_examples/lib/) directory for more practical use-cases.
## Philosophy
Pharaoh emerges as a backend framework, inspired by the likes of ExpressJS, to empower developers in building comprehensive server-side applications using Dart. The driving force behind Pharaoh's creation is a strong belief in the potential of Dart to serve as the primary language for developing the entire architecture of a company's product. Just as the JavaScript ecosystem has evolved, Pharaoh aims to contribute to the Dart ecosystem, providing a foundation for building scalable and feature-rich server-side applications.
## Contributors ✨
The Pharaoh project welcomes all constructive contributions. Contributions take many forms,
from code for bug fixes and enhancements, to additions and fixes to documentation, additional
tests, triaging incoming pull requests and issues, and more!
### Contributing Code To Pharaoh 🛠
To setup and contribute to Pharaoh, Install [`Melos`](https://melos.invertase.dev/~melos-latest) as a global package via [`pub.dev`](https://pub.dev/packages/melos);
```console
$ dart pub global activate melos
```
then initialize the workspace using the command below
```console
$ melos bootstrap
```
### Running Tests
To run the tests, you can either run `dart test` in the package you're working on or use the command below to run the full test suite:
```console
$ melos run tests
```
## People
[List of all contributors](https://github.com/codekeyz/pharaoh/graphs/contributors)
## License
[MIT](LICENSE)