Opinionated, web development framework for F# which implements the server-side, functional MVC pattern
Clone or download
faabergr and Krzysztof-Cieslak Tweak README.md build instructions (#144)
I was able to figure out what to do but someone who hasn't used .NET Core as much might be more confused about where to begin. Also tweaked some wording. Just wanted to try to make it a little more approachable. :)
Latest commit 67b5a0f Oct 7, 2018

README.md

Saturn

Saturn is a web development framework written in F# which implements the server-side MVC pattern. Many of its components and concepts will seem familiar to anyone with experience in other web frameworks like Ruby on Rails or Python’s Django.

It's heavily inspired by Elixir's Phoenix.

Read more about why I've decided to create Saturn, and some of its design choices on my blog - http://kcieslak.io/Reinventing-MVC-for-web-programming-with-F

Documentation

Saturn has nice documentation and I appreciate any help to improve it further by sending pull requests or just adding an issue with what you think is missing.

How to build

  1. Install the .NET Core SDK from https://www.microsoft.com/net/download
  2. Install FAKE: dotnet tool install fake-cli -g
  3. Inside the repo directory, run fake build

How to contribute

Imposter syndrome disclaimer: I want your help. No really, I do.

There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.

I assure you, that's not the case.

This project has some clear Contribution Guidelines and expectations that you can read here.

The contribution guidelines outline the process that you'll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.

And you don't just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work. (And yes, that includes giving feedback about the contribution guidelines.)

Thank you for contributing!

Contributing and copyright

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.

The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes.