MiniScaffold
An F# dotnet template for creating and publishing libraries and console applications with pre-configured build, test, and release automation.
What is MiniScaffold?
MiniScaffold is an F# dotnet template designed to bootstrap .NET 8.0 libraries and console applications with a complete, opinionated setup. It solves the problem of project initialization ambiguity by providing a pre-configured structure with build automation, testing, documentation, and release pipelines out of the box.
F# and .NET developers creating open-source libraries or console applications who want a standardized, production-ready project foundation without manual tooling integration.
Developers choose MiniScaffold because it dramatically reduces setup time, enforces consistent best practices, and automates the entire release lifecycle—from testing to NuGet publishing—all within a single, community-vetted template.
Overview
F# Template for creating and publishing libraries targeting library or console apps.
Use Cases
Best For
- Bootstrapping new F# library projects with full CI/CD
- Creating .NET console applications with multi-platform packaging
- Projects requiring automated NuGet package publishing and versioning
- Teams wanting consistent project structure and coding standards
- Open-source maintainers seeking integrated documentation generation
- Developers needing a pre-configured test and code coverage setup
Not Ideal For
- Projects using C# or other non-F# .NET languages
- Developers wanting minimal setup without CI/CD or release automation overhead
- Teams already committed to different build systems like MSBuild or Cake
- Applications requiring server-side web frameworks (e.g., ASP.NET Core)
Pros & Cons
Pros
Uses FAKE to automate builds, testing, packaging, and deployment, reducing manual configuration and ensuring repeatability.
Bundles Expecto for unit testing and Altcover with ReportGenerator for code coverage reports, providing quality assurance out of the box.
Handles versioning from CHANGELOG.md, creates GitHub releases, and publishes to NuGet, streamlining the entire release process.
Integrates Fantomas for consistent formatting and generates documentation from XML comments, promoting maintainability and standards.
Cons
Locks you into specific tools like FAKE and Expecto, which may not align with team preferences or existing workflows, limiting flexibility.
Known issues with file permissions (e.g., build.sh) on certain .NET SDK versions require manual fixes, adding friction to initial setup.
Focuses solely on .NET 8.0, so projects needing multi-targeting or compatibility with older frameworks require significant customization.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.