FormSharp

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 18 Open GitHub ↗

No one likes the drudgery of building form logic. Banish it with F#.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FormSharp

![Build](https://github.com/JamesRandall/FormSharp/actions/workflows/buildandtest.yml/badge.svg)

**This is very much work in progress - here be killer bunnies, but they're quickly being pacified**

![Alt text](https://raw.githubusercontent.com/JamesRandall/FormSharp/main/images/bunny.jpg)

FormSharp aims to take the drudgery out of creating data entry forms in F# by taking care of all the plumbing and presentation and hiding it behind a DSL. I've found myself in a couple of situations where I've had to build broad data entry systems and writing and maintaining this code manually will kill a small team.

The aim is to allow forms to be defined using a fairly simple and abstract DSL:

![Alt text](https://raw.githubusercontent.com/JamesRandall/FormSharp/main/images/dsl.png)

That can then be executed in different runtimes / environments using an appropriate renderer / executer:

![Alt text](https://raw.githubusercontent.com/JamesRandall/FormSharp/main/images/reactRuntime.png)

Keeping a few goals in mind as I work on it:

1. Support for multiple runtimes initially React, plain JavaScript and Spectre (console).
2. Support for multiple and custom renderers.
3. Easy to use - its supposed to save effort, not create effort.

The code is emerging from a production system and a poc and so is of varying quality and is definitely subject to significant change.

If you want to take a look at how it works best place to start is with the [Fable.React.Tailwind.Sample app](https://github.com/jamesrandall/formSharp/tree/samples/Fable.React.Tailwind.Sample).

Docs to follow as I build it out.

I was really tempted to call it Phorm but their are some Phorm-esque things in PHP land.

## Tests

Running the tests requires the installation of [Playwright for .NET](https://playwright.dev/dotnet/).

## Things to do

~~In a rough order.~~
Order is wherever fun takes me!

* Documentation
* GitHub Action for package release and initial package publish
* Token injection for API calls (skeleton is their)
* Additional components - radio buttons, text areas
* Add a Bootstrap renderer to the React package
* Add a Bulma renderer to the React package
* Add a vanilla HTML (no React) package (Tailwind and Bootstrap)
* Bring the Spectre support into the public repo from my poc

## Request for features, help and bug fixes

Sure. Go ahead. Issues and discussions are open. But I may ask for money in return. Releasing OSS doesn't come with any obligation and although some people seem to live in a world where money isn't needed most of us have a mortgage and bills to pay.

## Contributing

Best to speak to me first as I'm changing things a lot at the moment.

## License

Available under MIT. See the [LICENSE](https://github.com/jamesrandall/formSharp/tree/LICENSE) file.

FormSharp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README