1
1
# Forest Admin in Nodejs (Express.js & Sequelize)
2
+
2
3
[ ![ npm package] ( https://badge.fury.io/js/forest-express-sequelize.svg )] ( https://badge.fury.io/js/forest-express-sequelize )
3
- [ ![ CI status] ( https://github.com/ForestAdmin/forest-express-sequelize/workflows/.github/workflows/build.yml/ badge.svg )] ( https://github.com/ForestAdmin/forest-express-sequelize/actions )
4
+ [ ![ CI status] ( https://github.com/ForestAdmin/forest-express-sequelize/workflows/Build,%20Test%20and%20Deploy/ badge.svg?branch=master )] ( https://github.com/ForestAdmin/forest-express-sequelize/actions )
4
5
[ ![ Test Coverage] ( https://api.codeclimate.com/v1/badges/42d6d0fce013a6b96ae2/test_coverage )] ( https://codeclimate.com/github/ForestAdmin/forest-express-sequelize/test_coverage )
5
6
[ ![ semantic-release] ( https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg )] ( https://github.com/semantic-release/semantic-release )
6
7
@@ -9,6 +10,7 @@ Forest Admin provides an off-the-shelf administration panel based on a highly-ex
9
10
This project has been designed with scalability in mind to fit requirements from small projects to mature companies.
10
11
11
12
## Who Uses Forest Admin
13
+
12
14
- [ Apartmentlist] ( https://www.apartmentlist.com )
13
15
- [ Carbon Health] ( https://carbonhealth.com )
14
16
- [ Ebanx] ( https://www.ebanx.com )
@@ -22,9 +24,11 @@ This project has been designed with scalability in mind to fit requirements from
22
24
- And hundreds more…
23
25
24
26
## Getting started
27
+
25
28
[ https://docs.forestadmin.com/documentation/getting-started/installation ] ( https://docs.forestadmin.com/documentation/getting-started/installation )
26
29
27
30
## Documentation
31
+
28
32
[ https://docs.forestadmin.com/documentation/ ] ( https://docs.forestadmin.com/documentation/ )
29
33
30
34
## How it works
@@ -34,6 +38,7 @@ This project has been designed with scalability in mind to fit requirements from
34
38
</p >
35
39
36
40
Forest Admin consists of two components:
41
+
37
42
- The Admin Frontend is the user interface where you'll manage your data and configuration.
38
43
- 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.
39
44
@@ -45,27 +50,31 @@ user and your application data through the Admin API.
45
50
## Features
46
51
47
52
### CRUD
53
+
48
54
All of your CRUD operations are natively supported. The API automatically
49
55
supports your data models' validation and allows you to easily extend or
50
56
override any API routes' with your very own custom logic.
51
57
52
58
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CRUD.jpg " alt =" CRUD " >
53
59
54
60
### Search & Filters
61
+
55
62
Forest Admin has a built-in search allowing you to run basic queries to
56
63
retrieve your application's data. Set advanced filters based on fields and
57
64
relationships to handle complex search use cases.
58
65
59
66
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Search.jpg " alt =" Search and Filters " >
60
67
61
68
### Sorting & Pagination
69
+
62
70
Sorting and pagination features are natively handled by the Admin API. We're
63
71
continuously optimizing how queries are run in order to display results faster
64
72
and reduce the load of your servers.
65
73
66
74
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Sorting.jpg " alt =" Sorting and Pagination " >
67
75
68
76
### Custom action
77
+
69
78
A custom action is a button which allows you to trigger an API call to execute
70
79
a custom logic. With virtually no limitations, you can extend the way you
71
80
manipulate data and trigger actions (e.g. refund a customer, apply a coupon,
@@ -74,42 +83,49 @@ ban a user, etc.)
74
83
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Custom.jpg " alt =" Sorting and Pagination " >
75
84
76
85
### Export
86
+
77
87
Sometimes you need to export your data to a good old fashioned CSV. Yes, we
78
88
know this can come in handy sometimes :-)
79
89
80
90
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Export.jpg " alt =" Export " >
81
91
82
92
### Segments
93
+
83
94
Get in app access to a subset of your application data by doing a basic search
84
95
or typing an SQL query or implementing an API route.
85
96
86
97
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Segments.jpg " alt =" Segments " >
87
98
88
99
### Dashboards
100
+
89
101
Forest Admin is able to tap into your actual data to chart out your metrics
90
102
using a simple UI panel, a SQL query or a custom API call.
91
103
92
104
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Dashboard.jpg " alt =" Dashboard " >
93
105
94
106
### WYSIWYG
107
+
95
108
The WYSIWYG interface saves you a tremendous amount of frontend development
96
109
time using drag'n'drop as well as advanced widgets to build customizable views.
97
110
98
111
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Wysiwyg.jpg " alt =" WYSIWYG " >
99
112
100
113
### Custom HTML/JS/CSS
114
+
101
115
Code your own views using JS, HTML, and CSS to display your application data in
102
116
a more appropriate way (e.g. Kanban, Map, Calendar, Gallery, etc.).
103
117
104
118
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CustomHTML.jpg " alt =" Custom views " >
105
119
106
120
### Team-based permissions
121
+
107
122
Without any lines of code, manage directly from the UI who has access or can
108
123
act on which data using a team-based permission system.
109
124
110
125
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Teams.jpg " alt =" Team based permissions " >
111
126
112
127
### Third-party integrations
128
+
113
129
Leverage data from third-party services by reconciling it with your
114
130
application’s data and providing it directly to your Admin Panel. All your
115
131
actions can be performed at the same place, bringing additional intelligence to
@@ -118,12 +134,14 @@ your Admin Panel and ensuring consistency.
118
134
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-3rdParty.jpg " alt =" Third-party integrations " >
119
135
120
136
### Notes & Comments
137
+
121
138
Assign your teammates to specific tasks, leave a note or simply comment a
122
139
record, thereby simplifying collaboration all across your organization.
123
140
124
141
<img src =" https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Notes.jpg " alt =" Notes and Comments " >
125
142
126
143
### Activity logs
144
+
127
145
Monitor each action executed and follow the trail of modification on any data
128
146
with an extensive activity log system.
129
147
0 commit comments