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. If you want to dive deeper into the installation process of the product, we got you covered here.
This guide will help you to set up Forest Admin as a standalone process, using an example Postgres database.
Requirements
Node.js ^14.15.0 || ^16.13.0
NPM > 6.14.4 or yarn > 1.22.17
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.
Create a new JavaScript (Or TypeScript) project
Let's create a new folder and initiate a new JavaScript project.
Once everything is ready, install the following dependencies.
Create an index.js
and a .env
file.
Running
should be enough to be redirected to the "rate-install" page. However, Forest Admin currently doesn't have any collections to display.
Add a data source
If you want to test Forest Admin but don't have a database on hand, here is one!
docker run -p 5432:5432 --name forest_demo_database forestadmin/meals-database
The associated connection string will be postgres://lumber:secret@localhost:5432/meals
.
Now that you are fully onboarded, the only missing part is to add a data source. Forest Admin provides a way to create your own, but for this example, we will add a SQL Datasource.
To install the SQL Datasource package, you can run the following command
If you run on the example database provided above, simply add the following in your index.js
and .env
If you try to run the code as is, you'll be prompted to install the pg
driver manually. After doing:
You should be able to see the following log in your terminal:
And refreshing the Forest Admin app should display the following screen:
Click on the "eye" icons of the collections you want to display, then exit the layout editor and ...
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)
Last updated