A financial modeling framework focused on retirement, designed around extensibility and user choice.
The information provided/generated by RetireSimple and its Engine should not be the only source of information you use to make financial decisions. You should consult with a certified financial professional (especially one that is a certified fiduciary) before making any financial decisions or taking any actions related to your finances.
RetireSimple and any derivative application using the RetireSimple Engine is not responsible for any financial decisions or actions you take based on the information provided/generated by RetireSimple.
RetireSimple and its Engine are also subject to the conditions defined by the MIT License. A copy of the license along with the above disclaimer can be found in the LICENSE file.
We provide the following versions main RetireSimple Executable (which launches a web server and launches your browser to our Frontend):
| OS | Release Suffix | DIY Build | Prebuilt Binary |
|---|---|---|---|
| Windows 32-bit | win-x86 |
✅ | ✅ |
| Windows 64-bit | win-x64 |
✅ | ✅ |
| Windows ARM64 | win-arm64 |
✅ | ✅ |
| Linux 64-bit | linux-x64 |
✅ | ✅ |
| Linux ARM64 | linux-arm64 |
✅ | ✅ |
| MacOS 11+ Intel | osx.11-x64 |
✅ | ❌ |
| MacOS 11+ Apple Silicon | osx.11-arm64 |
✅ | ❌ |
For more information about MacOS Release Limitations, checkout the respective wiki page: TBD
Because the RetireSimple Engine uses .NET 6, it is able to be compiled for other platforms. This means any project using .NET 6 will be able to use the RetireSimple Engine. We provide a NuGet package via GitHub packages.
Happy Hacking!
To compile/develop RetireSimple, the following tools are required:
- .NET 6 (
dotnetCLI) dotnet-eftools (link)- Node.JS 16 (minimum compatible version, required for frontend build)
- IMPORTANT
pnpmv7 (install to global tools vianpm install -g pnpm)
The project can be opened in most modern IDEs and built using CLI tools, but was specifically constructed in Visual Studio which should provide the fullest compatibility with the project configuration.
The RetireSimple.Frontend project uses pnpm over npm for dependency management and managing builds. There is no difference in how you would normally build/run the frontend, except for using pnpm (i.e. pnpm run build, pnpm test, pnpm install, etc.). For more information about pnpm, visit their website.
A local release of RetireSimple can be built with dotnet publish on the RetireSimple.Backend project. We provide a publish profile with settings to optimize the build, so the recommended way to execute this build at the root of the repository is:
dotnet publish RetireSimple.Backend/RetireSimple.Backend.csproj -p:PublishProfile=RetireSimple.Backend/Properties/PublishProfiles/FolderProfiles.pubxmlMost of the documentation is still under construction and is subject to change until the initial release. This can be found on the Wiki
We have a general release plan with some of the rationale in the following excel sheet. Items in the sheet will include links to the corresponding GitHub Issues to validate progress. Items that were completed before this plan was created my not have a linked issue.
This project is licensed under the MIT License. See the LICENSE file for more information.
The RetireSimple Logo is based on multiple icons from the FontAwesome free icon set. These icons are licensed under the Creative Commons BY 4.0 License as stated here: https://fontawesome.com/license/free.
The following libraries are used by the RetireSimple Engine and are subject to their respective licenses:
- .NET 6 (MIT License)
- Entity Framework Core (MIT License)
- Math.NET Numerics (MIT License)
https://localhost:7199/swagger/index.html Displays endpoints for the API service