Geocode an address with Algolia

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Geocode an address with Algolia

This example shows you how to use an autocomplete address smart field to update a PostreSQL geography point (lat, long).

Requirements

• An admin backend running on forest-express-sequelize

• An algolia account

• algoliasearch npm package

How it works

Directory: /models

This directory contains the events.js file where the model is declared.

models/events.js

module.exports = (sequelize, DataTypes) => {
  const Model = sequelize.define(
    'events',
    {
      name: {
        type: DataTypes.STRING,
        primaryKey: true,
      },
      locationGeo: {
        type: DataTypes.GEOMETRY('POINT', 4326),
      },
      address: {
        type: DataTypes.STRING,
      },
    },
    {
      tableName: 'events',
      underscored: true,
      timestamps: false,
      schema: process.env.DATABASE_SCHEMA,
    }
  );

  Model.removeAttribute('id');
  Model.associate = () => {};

  return Model;
};

Directory: /forest

This directory contains the events.js file where the Smart Field Location setteris declared. This smart field will be used to update the value of the addressand locationGeo fields.

/forest/events.js

const algoliasearch = require('algoliasearch');

const places = algoliasearch.initPlaces(
  process.env.PLACES_APP_ID,
  process.env.PLACES_API_KEY
);

async function getLocationCoordinates(query) {
  try {
    const location = await places.search({ query, type: 'address' });
    console.log('search location coordinates result', location.hits[0]._geoloc);
    return location.hits[0]._geoloc;
  } catch (err) {
    console.log(err);
    return null;
  }
}

async function setEvent(event, query) {
  const coordinates = await getLocationCoordinates(query);
  event.address = query;
  event.locationGeo = `{"type": "Point", "coordinates": [${coordinates.lat}, ${coordinates.lng}]}`;
  console.log('new address', event.address);
  console.log('new location', event.locationGeo);
  return event;
}

collection('events', {
  fields: [
    {
      field: 'Location setter',
      type: 'String',
      // Get the data to be displayed.
      get: (event) => event.address,
      // Update using Algolia.
      set: (event, query) => setEvent(event, query),
    },
  ],
});

The field Location setter should use the address edit widget to enable address autocomplete.