Documentation overview

An overview of our documentation

Our documentation is broken down in the following sections:

• an introduction to Imagine, including:
  • what we are building,
  • an introduction to our SmartCompiler, and
  • an map of our V1 and upcoming functionality.
• how to get started with Imagine, including how to:
  • install Imagine's SmartCompiler and create a new Django app.
• how to generate code for various domains within your app using Imagine config file, including:
  • an overview of what we mean by domains
  • a high level outline of how to write an Imagine config file,
  • the specific settings and syntax for various app domains that we support, such as:
    • datamodel,
    • storage,
    • API,
    • authentication, and
    • testing.
• how to modify and integrate the generated code into your code base.
• an easy cheat sheet for:
  • the various Imagine SmartCompiler commands.
  • various settings you can choose when writing an Imagine config file, and
  • the domain specific syntax for all our supported domains summarized in a single page.