Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/francescovallone/serinus

Serinus is a minimalistic framework for building efficient and scalable backend applications powered by Dart. 🎯
https://github.com/francescovallone/serinus

backend dart dartlang server

Last synced: 3 months ago
JSON representation

Serinus is a minimalistic framework for building efficient and scalable backend applications powered by Dart. 🎯

Host: GitHub
URL: https://github.com/francescovallone/serinus
Owner: francescovallone
License: mit
Created: 2023-01-25T22:30:16.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-08-01T16:10:11.000Z (6 months ago)
Last Synced: 2024-08-02T09:29:39.310Z (6 months ago)
Topics: backend, dart, dartlang, server
Language: Dart
Homepage: https://docs.serinus.app
Size: 1.49 MB
Stars: 27
Watchers: 2
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![Serinus Logo][logo_white]][repo_link]

[![codecov](https://codecov.io/gh/francescovallone/serinus/branch/main/graph/badge.svg?token=A2337C1XGG)](https://codecov.io/gh/francescovallone/serinus)

[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/francescovallone/serinus/serinus_tests.yml?logo=dart&label=Tests)

[![Discord](https://img.shields.io/discord/1099781506978807919?logo=discord&logoColor=white)](https://discord.gg/FPwH2fEUVF)

[![CodeFactor](https://www.codefactor.io/repository/github/francescovallone/serinus/badge)](https://www.codefactor.io/repository/github/francescovallone/serinus)

Serinus is a framework written in Dart for building efficient and scalable server-side applications.

# Getting Started

## Packages

| Package | Version |

| ------- | ------- |

| [serinus](https://pub.dev/packages/serinus) | [![Pub Version](https://img.shields.io/pub/v/serinus?color=green&logo=dart)](https://pub.dev/packages/serinus) |

| [serinus_cli](https://pub.dev/packages/serinus_cli) | [![Pub Version](https://img.shields.io/pub/v/serinus_cli?color=green&logo=dart)](https://pub.dev/packages/serinus_cli) |

| [serinus_config](https://pub.dev/packages/serinus_config) | [![Pub Version](https://img.shields.io/pub/v/serinus_config?color=green&logo=dart)](https://pub.dev/packages/serinus_config) |

| [serinus_swagger](https://pub.dev/packages/serinus_swagger) | [![Pub Version](https://img.shields.io/pub/v/serinus_swagger?color=green&logo=dart)](https://pub.dev/packages/serinus_swagger) |

| [serinus_cors](https://pub.dev/packages/serinus_cors) | [![Pub Version](https://img.shields.io/pub/v/serinus_cors?color=green&logo=dart)](https://pub.dev/packages/serinus_cors) |

| [serinus_rate_limiter](https://pub.dev/packages/serinus_rate_limiter) | [![Pub Version](https://img.shields.io/pub/v/serinus_rate_limiter?color=green&logo=dart)](https://pub.dev/packages/serinus_rate_limiter) |

| [serinus_serve_static](https://pub.dev/packages/serinus_serve_static) | [![Pub Version](https://img.shields.io/pub/v/serinus_serve_static?color=green&logo=dart)](https://pub.dev/packages/serinus_serve_static) |

## Installation

To install Serinus you can use the following command:

```bash

dart pub global activate serinus_cli

```

## Create a new project

```bash

serinus create 

```

## Run the project

```bash

cd 

serinus run

```

By default the server will run on port 3000 and will listen for requests on localhost. You can change these settings modifying the file where you have defined the application (by default this file is `lib/main.dart`) or by passing the `--port` and `--host` flags to the `run` command:

```bash

serinus run --port=8080 --host=localhost

```

You can also start the application in development mode adding the `--dev` flag to the command:

```bash

serinus run --dev

```

In development mode the server will automatically restart when you change the source code.

## Documentation

You can find the documentation [here][documentation_link].

# License

Serinus is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.

# Contributing

If you want to contribute to Serinus, please read the [CONTRIBUTING](CONTRIBUTING.md) file.

[repo_link]: https://github.com/francescovallone/serinus

[documentation_link]: https://docs.serinus.app

[logo_white]: https://raw.githubusercontent.com/francescovallone/serinus/main/packages/serinus/assets/serinus-logo-long.png