https://github.com/oxidizing/sihl

A modular functional web framework
https://github.com/oxidizing/sihl

framework functional-programming functional-web-development modular ocaml web web-framework

Last synced: 21 days ago
JSON representation

A modular functional web framework

• Host: GitHub
• URL: https://github.com/oxidizing/sihl
• Owner: oxidizing
• License: mit
• Created: 2020-02-26T15:30:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T13:50:33.000Z (7 months ago)
• Last Synced: 2024-10-13T21:21:25.831Z (2 months ago)
• Topics: framework, functional-programming, functional-web-development, modular, ocaml, web, web-framework
• Language: OCaml
• Homepage: https://v3.ocaml.org/p/sihl
• Size: 7.37 MB
• Stars: 359
• Watchers: 10
• Forks: 13
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - sihl

README

        


  

    

  

  


    A modular and functional web framework

    


    

    Explore the docs »

    


    


    Getting Started

    ·

    Demo project

    ·

    Report Bug

    ·

    Request Feature

  


## Table of Contents

* [About](#about)

* [Getting Started](#getting-started)

  * [Prerequisites](#prerequisites)

  * [Create a project](#create-a-project)

* [Background](#background)

* [Documentation](#documentation)

* [Roadmap](#roadmap)

* [Contributing](#contributing)

* [License](#license)

* [Contact](#contact)

* [Acknowledgements](#acknowledgements)

## About 

*Note that even though Sihl is being used in production, the API is still under active development.*

Sihl is a batteries-included web framework built on top of [Opium](https://github.com/rgrinberg/opium), [caqti](https://github.com/paurkedal/ocaml-caqti), [logs](https://erratique.ch/software/logs) and [many more](https://github.com/oxidizing/sihl/blob/master/dune-project). Thanks to the modular architecture, included batteries can be swapped easily. Statically typed functional programming with OCaml makes web development fun and safe.

## Getting Started

Checkout the [getting started](https://oxidizing.github.io/sihl/sihl/index.html#getting-started) section of the documentation.

If you want to jump into code have a look at the [demo project](https://github.com/oxidizing/sihl-demo). 

## Background

### Design Goals

These are the main design goals of Sihl.

#### Fun

The overarching goal is to make web development fun. *Fun* is hard to quantify, so let's just say *fun* is maximized when frustration is minimized. This is what the other design goals are here for.

#### Swappable batteries included

Sihl should provide high-level features that are common in web applications out-of-the-box. It should provide sane and ergonomic defaults for 80% of the use cases with powerful but not necessarily ergonomic customization options for the other 20%.

#### Ergonomic but safe

OCaml itself ensures a certain level of correctness at compile-time. In order to optimized developer experience, some things are not verified at compile-time but at start-time. Sihl makes sure that your app does not start without the needed configurations and the required environment.

### Features

These are some of things that Sihl can take care of for you.

- Database handling (pooling, transactions, migrations)

- Configuration (from env variables to configuration services)

- Logging

- User management

- Token management 

- Session management 

- HTTP routes & middlewares

- Flash Messages 

- Authentication

- Authorization

- Emailing

- CLI Commands

- Job Queue

- Schedules

- Block Storage

### Do we need another web framework?

Yes, because all other frameworks have not been invented here!

On a more serious note, originally we wanted to collect a set of services, libraries, best practices and architecture to quickly and sustainably spin-off our own tools and products. 

An evaluation of languages and tools lead us to build the 5th iteration of what became Sihl with OCaml. We believe OCaml is a phenomenal place to build web apps.

Thanks to OCaml, Sihl ...

* ... runs fast 

* ... compiles fast 

* ... is pragmatic and safe

* ... is fun to use

## Documentation

The API documentation for the latest version can be found here: https://oxidizing.github.io/sihl

## Ecosystem

- https://github.com/uzh/ask

## Roadmap

Our main goal is to stabilize the service APIs, so updating Sihl in the future becomes easier. We would like to attract contributions for service contributions, once the framework reaches some level of maturity.

## Contributing

Check out the [Contributing guidelines](/CONTRIBUTING.md).

## License

Copyright (c) 2020 Oxidizing Systems

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Oxidizing Systems - [@oxidizingsys](https://twitter.com/oxidizingsys) - [email protected]

Project Link: [https://github.com/oxidizing/sihl](https://github.com/oxidizing/sihl)