package sihl-facade

README.md

A modular and functional web framework
Explore the docs »

Getting Started · Report Bug · Request Feature

Table of Contents

• About

• Getting Started

  • Prerequisites

  • Create a project

• Background

• Documentation

• Roadmap

• Contributing

• License

• Contact

• 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, caqti, logs and many more. 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

The easiest way to get started is by using Spin.

Prerequisites

• Basic understanding of OCaml

• Installation of opam

To initialize opam:

opam init

To install Spin, following the instructions here. You can install it using opam:

opam install spin

Create a project

Generate a start project:

spin new https://github.com/oxidizing/spin-sihl.git app

Visit http://localhost:3000/ to use the demo to-do list app.

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 is ...

• ... 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/sihl/Sihl/index.html

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

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. If you have any questions just contact us.

1. Fork the Project

2. Create your Feature Branch (git checkout -b feature/amazing-feature)

3. Commit your Changes (git commit -m 'Add some amazing feature')

4. Push to the Branch (git push origin feature/amazing-feature)

5. Open a Pull Request

License

Copyright (c) 2020 Oxidizing Systems

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

Contact

Oxidizing Systems - @oxidizingsys - hello@oxidizing.io

Project Link: https://github.com/oxidizing/sihl

Acknowledgements

Sihl would not be possible without some amazing projects like:

• OCaml

• Reason

• Opium

• Caqti

• Tree vector created by brgfx - www.freepik.com

• And many more!