shivneri

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

[![GitHub version](https://badge.fury.io/gh/ujjwalguptaofficial%2Fshivneri.svg)](https://badge.fury.io/gh/ujjwalguptaofficial%2Fshivneri) ![Crystal CI](https://github.com/ujjwalguptaofficial/shivneri/workflows/Crystal%20CI/badge.svg?branch=master) [![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://shivneriforcrystal.com/)
# Shivneri

Component based MVC web framework based on fort architecture for [crystal](https://crystal-lang.org/) targeting good code structures, modularity & performance.

# Features

* Based on [Fort](https://github.com/ujjwalguptaofficial/fort) architecture.
* MVC Framework and follows OOPS approach so everything is class and object.
* Provides components - Wall, Shield and Guard. Components help modularize the application.
* Everything is configurable - you can configure your session store, view engine, websocket etc.
* Dependency Injection.
* Everything can be unit tested, so you can use a [TDD](https://guide.freecodecamp.org/agile/test-driven-development/) approach.

# Examples

* Rest Api - https://github.com/ujjwalguptaofficial/shivneri-examples/tree/master/rest
* WebSocket - https://github.com/ujjwalguptaofficial/shivneri-examples/tree/master/chat
* Authentication - https://github.com/ujjwalguptaofficial/shivneri-examples/tree/master/authentication
* Request Logging - https://github.com/ujjwalguptaofficial/shivneri-examples/tree/master/request-logger

# Doc Site

https://shivneriforcrystal.com/