Skip to main content

Prerequisites


Before getting started with SWAIN, make sure you have:

  • Database Access – Credentials for your existing database (host, port, database type, database name, username,username and password) for one or more stages (Development / Staging / Production).
  • AnDatabase Existing SchemaPermissionsAYou databaseare withauthorized atto least two tablesread and atwrite leastthe onetarget relationship,database so that SWAIN can discoverscan the schema and buildgenerate endpoints.
  • APISMTP Client FamiliarityConfigurationBasicIf familiarityusing withemail anfeatures APIsuch clientas likepassword Postmanresets toor testemail verification, you’ll need SMTP host, port, username and password, a From address and name, a Base URL (your generatedwebsite/app endpoints.origin) and a Password Reset Path (must include a %s placeholder for the token).
  • AppropriateOAuth PrivilegesSetupSufficientIf privilegesusing tosocial createlogin, databasehave usersGoogle and manageGitHub credentialsOAuth ifclient necessary.IDs and secrets and approved redirect URLs.