Quick start

Let's get you up and running on Forest Admin in minutes!

Introduction
Forest Admin is a low-code internal tool solution that scales with your project. With 30+ out-of-the-box tools and pre-built UI components, you can ship an admin panel in a few minutes, and then easily customize it to meet your specific business logic. Thanks to the layout editor, non-technical team members can adjust the UI to their needs.
Forest Admin has a unique hybrid architecture - only the frontend is managed on Forest Admin servers, which gives you the flexibility of a SaaS tool without compromising on data security.
Quick Start
Forest Admin offers a lot of flexibility in terms of installation. The following guide provides a way to start using Forest Admin in minutes.
Requirements
PHP ^8.0
Symfony ^5.4
If you want to use our example database, make sure Docker is installed and running
Create an account and follow the onboarding
Go to https://app.forestadmin.com/signup ↗, and create an account and a new project.
Add dependency forestadmin/symfony-forestadmin to your symfony app
composer require forestadmin/symfony-forestadmin
Add the configuration to your config/routes.yaml file
forest_admin_bundle:
  resource: '@SymfonyForestAdminBundle/config/routes'
  type: directory
Run the following command in your terminal
php bin/console forest:install THE-KEY-PROVIDED-BY-FORESTADMIN
Once the installation is finish, you have a new configuration file (forest/symfony_forest_admin.php) and two environments variables in your .env
symfony_forest_admin.php
.env
use ForestAdmin\AgentPHP\Agent\Utils\Env;
use ForestAdmin\AgentPHP\DatasourceDoctrine\DoctrineDatasource;
use ForestAdmin\SymfonyForestAdmin\Service\ForestAgent;
​
return static function (ForestAgent $forestAgent) {
​
    $forestAgent->addDatasource(
        new DoctrineDatasource(
            $forestAgent->getEntityManager(),
            [
                'url' => Env::get('DATABASE_URL'),
            ]
        ),
    )
        ->build();
};
FOREST_AUTH_SECRET=<This is provided during the onboarding steps>
FOREST_ENV_SECRET=<This is provided during the onboarding steps>
Running
symfony serve
should be enough to be redirected to the "rate-install" page.
You're all set!
At the end of your onboarding, you will out-of-the-box be able to:
Access all your data (1)
Export your data (2)
Add a record (3)
View and edit a record (4)
Edit your UI (5)
Search and filter (6)

Getting started - Previous

How it works

Next - Getting started

Troubleshooting

Last modified 1mo ago