@@ -20,109 +20,112 @@ This project has been designed with scalability in mind to fit requirements from
20
20
- And hundreds more…
21
21
22
22
## Getting Started
23
-
24
- Install Forest Admin here: [ https://docs.forestadmin.com/documentation/getting-started/installation ] ( https://docs.forestadmin.com/documentation/getting-started/installation )
23
+ [ https://docs.forestadmin.com/documentation/getting-started/installation ] ( https://docs.forestadmin.com/documentation/getting-started/installation )
25
24
26
25
## Documentation
27
26
[ https://docs.forestadmin.com/documentation/ ] ( https://docs.forestadmin.com/documentation/ )
28
27
28
+ ## How it works
29
+
30
+ <p align =" center " style =" margin : 60px 0 " >
31
+ <img width =" 100% " src =" https://www.forestadmin.com/public/img/illustrations-dev/schema-1.png " alt =" Howitworks " >
32
+ </p >
33
+
34
+ Forest Admin consists of two components:
35
+ - The Admin Frontend is the user interface where you'll manage your data and configuration.
36
+ - The Admin Backend API hosted on your servers where you can find and extend your data models and all the business logic (routes, actions, …) related to your admin panel.
37
+
38
+ The Forest Admin gem (aka Forest Liana) introspects all your data model
39
+ and dynamically generates the Admin API hosted on your servers. The Forest Admin
40
+ interface is a web application that handles communication between the admin
41
+ user and your application data through the Admin API.
42
+
29
43
## Features
30
44
31
45
### CRUD
32
46
All of your CRUD operations are natively supported. The API automatically
33
47
supports your data models' validation and allows you to easily extend or
34
48
override any API routes' with your very own custom logic.
35
49
36
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/crud .jpg " alt =" CRUD " >
50
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CRUD .jpg " alt =" CRUD " >
37
51
38
52
### Search & Filters
39
53
Forest Admin has a built-in search allowing you to run basic queries to
40
54
retrieve your application's data. Set advanced filters based on fields and
41
55
relationships to handle complex search use cases.
42
56
43
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/search .jpg " alt =" Search and Filters " >
57
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Search .jpg " alt =" Search and Filters " >
44
58
45
59
### Sorting & Pagination
46
60
Sorting and pagination features are natively handled by the Admin API. We're
47
61
continuously optimizing how queries are run in order to display results faster
48
62
and reduce the load of your servers.
49
63
50
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/sorting .jpg " alt =" Sorting and Pagination " >
64
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Sorting .jpg " alt =" Sorting and Pagination " >
51
65
52
66
### Custom action
53
67
A custom action is a button which allows you to trigger an API call to execute
54
68
a custom logic. With virtually no limitations, you can extend the way you
55
69
manipulate data and trigger actions (e.g. refund a customer, apply a coupon,
56
70
ban a user, etc.)
57
71
58
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/custom .jpg " alt =" Sorting and Pagination " >
72
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Custom .jpg " alt =" Sorting and Pagination " >
59
73
60
74
### Export
61
75
Sometimes you need to export your data to a good old fashioned CSV. Yes, we
62
76
know this can come in handy sometimes :-)
63
77
64
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/export .jpg " alt =" Export " >
78
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Export .jpg " alt =" Export " >
65
79
66
80
### Segments
67
81
Get in app access to a subset of your application data by doing a basic search
68
82
or typing an SQL query or implementing an API route.
69
83
70
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/segments .jpg " alt =" Segments " >
84
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Segments .jpg " alt =" Segments " >
71
85
72
86
### Dashboards
73
87
Forest Admin is able to tap into your actual data to chart out your metrics
74
88
using a simple UI panel, a SQL query or a custom API call.
75
89
76
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/dashboard .jpg " alt =" Dashboard " >
90
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Dashboard .jpg " alt =" Dashboard " >
77
91
78
92
### WYSIWYG
79
93
The WYSIWYG interface saves you a tremendous amount of frontend development
80
94
time using drag'n'drop as well as advanced widgets to build customizable views.
81
95
82
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/wysiwyg .jpg " alt =" WYSIWYG " >
96
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Wysiwyg .jpg " alt =" WYSIWYG " >
83
97
84
98
### Custom HTML/JS/CSS
85
99
Code your own views using JS, HTML, and CSS to display your application data in
86
100
a more appropriate way (e.g. Kanban, Map, Calendar, Gallery, etc.).
87
101
88
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/customhtml .jpg " alt =" Custom views " >
102
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CustomHTML .jpg " alt =" Custom views " >
89
103
90
104
### Team-based permissions
91
105
Without any lines of code, manage directly from the UI who has access or can
92
106
act on which data using a team-based permission system.
93
107
94
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/team .jpg " alt =" Team based permissions " >
108
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Teams .jpg " alt =" Team based permissions " >
95
109
96
110
### Third-party integrations
97
111
Leverage data from third-party services by reconciling it with your
98
112
application’s data and providing it directly to your Admin Panel. All your
99
113
actions can be performed at the same place, bringing additional intelligence to
100
114
your Admin Panel and ensuring consistency.
101
115
102
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/integration .jpg " alt =" Third-party integrations " >
116
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-3rdParty .jpg " alt =" Third-party integrations " >
103
117
104
118
### Notes & Comments
105
119
Assign your teammates to specific tasks, leave a note or simply comment a
106
120
record, thereby simplifying collaboration all across your organization.
107
121
108
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/notes .jpg " alt =" Notes and Comments " >
122
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Notes .jpg " alt =" Notes and Comments " >
109
123
110
124
### Activity logs
111
125
Monitor each action executed and follow the trail of modification on any data
112
126
with an extensive activity log system.
113
127
114
- <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/activity.jpg " alt =" Activity logs " >
115
-
116
- ## How it works
117
-
118
- The Forest Admin gem (aka Forest Liana) introspects all your data model
119
- and dynamically generates the Admin API hosted on your servers. The Forest Admin
120
- interface is a web application that handles communication between the admin
121
- user and your application data through the Admin API.
122
-
123
- <p align =" center " style =" margin : 60px 0 " >
124
- <img width =" 100% " src =" https://www.forestadmin.com/public/img/illustrations-dev/schema-1.svg " alt =" Howitworks " >
125
- </p >
128
+ <img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Activity.jpg " alt =" Activity logs " >
126
129
127
130
## How to contribute
128
131
0 commit comments