SUMMARY.md

Table of contents

• Forest Admin

Getting Started

• Quick start
• Development workflow

Reference Guide

• How it works
  • Environments
  • Developing on Forest Admin
    • Using branches
    • Deploying your changes
    • Forest CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:reset
      • environments:create
      • deploy
      • schema:diff [beta]
    • Express packages
• Models
  • Enrich your models
  • Relationships
    • Create a Smart relationship
      • GetIdsFromRequest
    • Smart Relationship Examples
      • Smart hasMany relationship in mongoDB
• Actions
  • Create and manage Smart Actions
    • Use a Smart Action Form
  • Smart Action Examples
    • Calculate the distance between two string addresses
    • Impersonate a user
    • Create a record with a multiselect through a many-to-many relationship
    • Handle enums with alias labels in a smart action
    • Dropdown with list of values in smart action form
    • Custom dynamic dropdown in a form using smart collections
    • Refresh hasMany relationship in smart action
    • Smart segment to restrict access to an action on a record details view
    • BelongsToMany edition through smart collection
    • Upload files to amazon s3
    • Upload several files with the File Picker
    • Retrieve smart field info in a smart action
    • Smart action to create several records from the input of a single smart action form
    • Add many existing records at the same time (hasMany-belongsTo relationship)
    • Call a webhook with record ids
    • Bulk update records
• Smart Fields
  • Smart Field Examples
    • Add an HTML credit card as a smart field in a summary view
    • Display field with complex info in html format (rich text editor)
    • Generate signed urls to display S3 files in a smart field
    • Print a status object in a single line field
    • Sort by smart field
    • Sort by smart field that includes value from a belongsTo relationship
    • Add fields destined to the create form
    • Add validation to a smart field edition
    • Display smart field as progress bar using rich text editor
    • Update point geometry field using a smart field and algolia api
• Smart Collections
  • Examples
    • Create a Smart Collection with Amazon S3
    • Smart relationship between model and stripe cards
    • Create records from a Smart collection
    • Searchable smart collection with records fetched from hubspot API
  • Serializing your records
• Routes
  • Default routes
  • Extend a route
  • Override a route
• Integrations
  • Stripe
  • Mixpanel
  • Intercom
  • Elasticsearch
    • Interact with your Elasticsearch data
    • Elasticsearch service/utils
    • Another example
  • Zendesk
    • Authentication, Filtering & Sorting
    • Display Zendesk tickets
    • Display Zendesk users
    • View tickets related to a user
    • Bonus: Direct link to Zendesk + change priority of a ticket
  • Dwolla
    • Display Dwolla customers
    • Display Dwolla funding sources
    • Display Dwolla transfers
    • Link users and Dwolla customers
    • Dwolla Service
  • Razorpay
  • Hubspot
    • Create a Hubspot company
    • Display Hubspot companies
  • Twilio
    • Send an SMS with Twilio and Zapier
  • Azure Table Storage
  • Slack
    • Send Smart Action notifications to Slack
  • Algolia
    • Geocode an address with Algolia
• Smart Views
  • Create a Map view
  • Create a Calendar view
  • Create a Shipping view
  • Create a Gallery view
  • Create a custom tinder-like validation view
  • Create a dynamic calendar view for an event-booking use case
  • Create a custom moderation view
• Smart Segments
• Scopes
  • Create a scope more than one level away based on a Smart field
  • Scope on a smart field extracting a json's column attribute
• Performance
• Charts
  • Create an API-based Chart
  • Create a Smart Chart
  • Create Charts with AWS Redshift

Extra help

• Setup
  • Install
  • Connecting Forest Admin to Your Database (Forest Cloud)
  • Forest Admin IP white-listing (Forest Cloud)
  • Why HTTPS is necessary even locally
  • Troubleshooting
  • Prevent permission errors at installation
  • Deploy your admin backend to AWS
  • Deploy your admin backend on Heroku
  • Deploy your admin backend to Ubuntu server
  • Deploy your admin backend to Google Cloud Platform
  • Install Forest Admin on a remote machine
  • Use Forest Admin with a read-only database
  • Configuring CORS headers
  • Running Forest Admin on multiple servers
  • Flatten nested fields (MongoDB)
• Upgrade
  • Upgrade notes (Rails)
    • Upgrade to v9
    • Upgrade to v8
    • Upgrade to v7
    • Upgrade to v6
    • Upgrade to v5
    • Upgrade to v4
    • Upgrade to v3
  • Upgrade notes (SQL, Mongodb)
    • Upgrade to v9
    • Upgrade to v8
    • Upgrade to v7
    • Upgrade to v6
    • Upgrade to v5
    • Upgrade to v4
    • Upgrade to v3
  • Update your models' definition
  • Monitor your Forest's status
  • Manage your Forest Admin environments programmatically
  • Changing your domain name
  • Migrate to the new role system
  • Push your new version to production
• Databases
  • Use a demo SQL database
  • Use a demo MongoDB database
  • Populate a postgreSQL database on Heroku
  • Connect to a read replica database
  • Plug multiple schemas
  • Add new databases
  • Manage SQL views
• Settings
  • Customize your /forest folder
  • Disable automatic Forest Admin schema update
  • Include/exclude models
  • Display extensive logs
  • Laravel specific settings
• Releases Support
• Other documentations