https://github.com/shmew/feliz.materialui

Feliz-style Fable bindings for Material-UI
https://github.com/shmew/feliz.materialui

dsl elmish elmish-applications fable fable-bindings feliz fsharp material-ui react

Last synced: 22 days ago
JSON representation

Feliz-style Fable bindings for Material-UI

• Host: GitHub
• URL: https://github.com/shmew/feliz.materialui
• Owner: Shmew
• License: mit
• Created: 2019-09-01T08:49:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T10:24:11.000Z (4 months ago)
• Last Synced: 2024-11-14T14:02:04.215Z (about 1 month ago)
• Topics: dsl, elmish, elmish-applications, fable, fable-bindings, feliz, fsharp, material-ui, react
• Language: F#
• Homepage: https://shmew.github.io/Feliz.MaterialUI/
• Size: 12.3 MB
• Stars: 69
• Watchers: 8
• Forks: 20
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Feliz.MaterialUI

[Feliz](https://github.com/Zaid-Ajaj/Feliz)-style Fable bindings for [Material-UI](https://material-ui.com/).

Documentation

--------------

https://shmew.github.io/Feliz.MaterialUI/

Contributing

------------

This project uses `fake`, `paket`, and `femto` as .NET Core 3 local tools. Therefore, run `dotnet tool restore` to restore the necessary CLI tools before doing anything else.

To run targets using Fake: `dotnet fake build -t TargetName`

### Regular maintenance

1. Run the `RegularMaintenance` target, which will update all packages as well as the Femto metadata in `Feliz.MaterialUI.fsproj`, and regenerate the bindings based on the live MUI docs

2. Check all changes to Feliz.MaterialUI and adjust the generator’s API parser as needed. Remember to check all doc comment updates too, since changes there may indicate that something must be changed elsewhere. Run the `RegenerateFromCache` target (or run the generator project in VS) to re-generate based on the recently downloaded HTML pages.

3. Update the version number in `Feliz.MaterialUI.fsproj`

4. Update `RELEASE_NOTES.md`

5. Update relevant docs/samples (typically in `docs-app/public/pages`, potentially also by adding menu items in `App.fs`)

6. Run the `CiBuild` target to check that everything compiles

7. Run the `Docs:Run` target to verify that the docs are still working

8. Commit and tag the commit (this is what triggers deployment from  AppVeyor). For consistency, the tag should be identical to the version (e.g. `1.2.3`).

9. Push the changes and the tag to the repo. If AppVeyor build succeeds, the package is automatically published to NuGet.

10. Publish the docs by running the `Docs:Publish` target