diff --git a/docs/recipes/package-management/add-nuget-package-to-client.md b/docs/recipes/package-management/add-nuget-package-to-client.md new file mode 100644 index 00000000..1b9d0576 --- /dev/null +++ b/docs/recipes/package-management/add-nuget-package-to-client.md @@ -0,0 +1,11 @@ +# How do I add a NuGet package to the Client? +Adding packages to the Client project is a very [similar process to the Server](../add-nuget-package-to-server), with a few key differences: + +- Any references to the `Server` directory should be `Client` + +- Client code written in F# is converted into JavaScript using [Fable](https://fable.io/docs/index.html). Because of this, we must be careful to only reference libraries which are [Fable compatible](https://fable.io/docs/your-fable-project/use-a-fable-library.html). + +- If the NuGet package uses any JS libraries you must install them. + For simplicity, [use Femto to sync](./sync-nuget-and-npm-packages.md) - if the NuGet package is compatible - or [install via NPM](./add-npm-package-to-client.md) manually, if not. + +There are [lots of great libraries](../../awesome-safe-components.md) available to choose from. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d74e39e5..6651bde1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -87,6 +87,7 @@ nav: - Package Management: - Add an NPM package to the Client: "recipes/package-management/add-npm-package-to-client.md" - Add a NuGet package to the Server: "recipes/package-management/add-nuget-package-to-server.md" + - Add a NuGet package to the Client: "recipes/package-management/add-nuget-package-to-client.md" - Migrate to Paket from NuGet: "recipes/package-management/migrate-to-paket.md" - Migrate to NuGet from Paket: "recipes/package-management/migrate-to-nuget.md" - Sync NuGet and NPM Packages: "recipes/package-management/sync-nuget-and-npm-packages.md" @@ -152,7 +153,6 @@ nav: - Package Management: - Add an NPM package to the Client: "v4-recipes/package-management/add-npm-package-to-client.md" - Add a NuGet package to the Server: "v4-recipes/package-management/add-nuget-package-to-server.md" - - Add a NuGet package to the Client: "v4-recipes/package-management/add-nuget-package-to-client.md" - Migrate to Paket from NuGet: "v4-recipes/package-management/migrate-to-paket.md" - Migrate to NuGet from Paket: "v4-recipes/package-management/migrate-to-nuget.md" - Sync NuGet and NPM Packages: "v4-recipes/package-management/sync-nuget-and-npm-packages.md"