Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midori-rb/midori.rb
Lightweight, Flexible and Fast Ruby Web Framework
https://github.com/midori-rb/midori.rb
Last synced: 3 months ago
JSON representation
Lightweight, Flexible and Fast Ruby Web Framework
- Host: GitHub
- URL: https://github.com/midori-rb/midori.rb
- Owner: midori-rb
- License: mit
- Created: 2016-09-09T02:25:41.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-01-30T17:25:27.000Z (over 3 years ago)
- Last Synced: 2024-03-19T00:25:53.409Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 1.74 MB
- Stars: 873
- Watchers: 50
- Forks: 57
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-github-star - midori.rb - rb | 872 | (Ruby)
- awesome-stars - midori-rb/midori.rb - Lightweight, Flexible and Fast Ruby Web Framework (Ruby)
README
# midori
**This project is still not production-ready. Questions, suggestions and pull requests are highly welcome.**
[![Backers on Open Collective](https://opencollective.com/midorirb/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/midorirb/sponsors/badge.svg)](#sponsors)
![Logo and Slogan](https://github.com/midori-rb/midori.rb/raw/master/.resources/slogan.png)
## Description
Midori is a Ruby Web Framework, providing high performance and proper abstraction.
### Requirements
- **Ruby** >= 3.0.0.rc1
## Installation
```bash
gem install midori.rb
```**With Bundler**
```ruby
gem 'midori.rb'
``````bash
bundle install
```## FAQ
### Name
The name **midori** comes from **midori machi**, which was the place I stay on my first travel to Tokyo.
### Semantic Versioning
Version consists of four numbers:
| | Milestone | Major | Minor | Patch |
| --------------- | :---------------: | :----------------------: | :---------: | :------: |
| **Example** | 1. | 2. | 1. | 5 |
| **Explanation** | Milestone version | Incompatible API changes | Add feature | Fix bugs |**Note: Before version v1.0, there's no minor version API compatible ensuring.**
### Contributing
See [Contributing Guidelines](CONTRIBUTING.md) before you leave any comment.
This project exists thanks to all the people who contribute.[![Contributors](https://opencollective.com/midorirb/contributors.svg?width=890)](https://github.com/midori-rb/midori.rb/graphs/contributors)
### Tutorial & Example
There is an unfinished tutorial available [here](https://github.com/midori-rb/midori-tutorial).
There is also an example showing how to use midori with a todo-list web app available [here](https://github.com/midori-rb/midori-todo-example).
## Roadmap
**Development roadmap has been moved [here](https://github.com/midori-rb/midori.rb/wiki/Roadmap).**
**Detailed release notes for published versions can be seen [here](https://github.com/midori-rb/midori.rb/releases).**
## Midori 2 Goals
1. Support HTTP/2
2. Support RPC/ZeroMQ Based Server
3. Add MVC abstraction example with scaffold
4. Improve structure for fitting [AutoFiber](https://bugs.ruby-lang.org/issues/13618)
5. More examples on using midori## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/midorirb#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/midorirb#sponsor)]