Skip to content

Add lots of recipes #154

@isaacabraham

Description

@isaacabraham

This is a tentative list of "recipes" or "how-to" guides that the docs should offer. Hopefully each should be relatively small and quick to author!

Upgrading from SAFE v1

  • How do I upgrade a SAFE v1 project to SAFE v2?

Hosting

  • How do I host inside Docker?
  • How do I host inside Azure App Service?
  • How do I host inside Amazon Web Service?
  • How do I host inside IIS?
  • How do I host inside Google Cloud Platform App Engine?

Build

  • How should I combine the build outputs from client and server?
  • How do I add a build script to the project e.g. FAKE?
  • How do I remove the use of FAKE?

Package Management

  • How do I add a nuget package to the server?
  • How do I add a nuget package to the client?
  • How do I add an NPM package to the client?
  • How do I ensure NPM and Nuget packages stay in sync?
  • How do I migrate to Paket?
  • How do I migrate to Nuget?
  • How do I migrate to Yarn instead of NPM?

Client / server communication

  • How do I add support for Fable Remoting?
  • How do I add support for SignalR (https://shmew.github.io/Fable.SignalR)?
  • How do I add support for GraphQL?
  • How do I add a POST endpoint?
  • How do I add a GET endpoint?
  • How do I handle server errors on the client?
  • How do I share types between client and server?
  • How do I share code between client and server?
  • How do I add Server to Client communication with WebSockets?
  • What are my serialization options for HTTP communication?
  • How do I enable Server Side Rendering?
  • How do I configure Thoth to work with Decimals and other types?
  • How do I serve a file from the back-end?
  • How do I upload a file from the client?
  • How do I show server errors on the client?

Developing and Testing

  • How do I test my client application?
  • How do I test my server application?
  • How do I use hot reloading?
  • How do I debug my SAFE apps?
  • How do I add support for the remote container extension in VS Code?
  • How do I do logging in SAFE apps?

Fable

  • How do I reference an NPM module?
  • How do I use a third-party React package?

UI

  • What is the difference between Fable React and Feliz?
  • How do I add Bulma support?
  • How do I use different Bulma styles?
  • How do I add use raw CSS styles?
  • How do I add support for Feliz?
  • How do I add support for font awesome?
  • How do I use SASS with SAFE apps?
  • How do I migrate from a CDN stylesheet to an NPM package?

Server

  • How do I use Giraffe instead of Saturn?

Other Platforms

  • How do I share code between Web and Console applications?

WebPack

  • How do I add support for older browsers?

Other

  • How do I add application configuration?
  • How do I add environment specific configuration?

Security

  • How do I add oauth authentication to the Server?
  • How do I perform a standard login flow across my application?
  • How do I do authentication and role-based authorization using Azure AD?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions