Skip to content

Commit c9f63c9

Browse files
docs(readme): fix interface screenshots display (#358)
1 parent abcf8d8 commit c9f63c9

File tree

2 files changed

+31
-26
lines changed

2 files changed

+31
-26
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
### Changed
55
- Technical - Patch CI configuration warnings.
66
- Readme - Update the community badge.
7+
- Readme - Fix interface screenshots display.
8+
- Readme - Update and re-position the "How it works" section.
79

810
## RELEASE 5.1.1 - 2020-04-20
911
### Fixed

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,109 +20,112 @@ This project has been designed with scalability in mind to fit requirements from
2020
- And hundreds more…
2121

2222
## 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)
2524

2625
## Documentation
2726
[https://docs.forestadmin.com/documentation/](https://docs.forestadmin.com/documentation/)
2827

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+
2943
## Features
3044

3145
### CRUD
3246
All of your CRUD operations are natively supported. The API automatically
3347
supports your data models' validation and allows you to easily extend or
3448
override any API routes' with your very own custom logic.
3549

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">
3751

3852
### Search & Filters
3953
Forest Admin has a built-in search allowing you to run basic queries to
4054
retrieve your application's data. Set advanced filters based on fields and
4155
relationships to handle complex search use cases.
4256

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">
4458

4559
### Sorting & Pagination
4660
Sorting and pagination features are natively handled by the Admin API. We're
4761
continuously optimizing how queries are run in order to display results faster
4862
and reduce the load of your servers.
4963

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">
5165

5266
### Custom action
5367
A custom action is a button which allows you to trigger an API call to execute
5468
a custom logic. With virtually no limitations, you can extend the way you
5569
manipulate data and trigger actions (e.g. refund a customer, apply a coupon,
5670
ban a user, etc.)
5771

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">
5973

6074
### Export
6175
Sometimes you need to export your data to a good old fashioned CSV. Yes, we
6276
know this can come in handy sometimes :-)
6377

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">
6579

6680
### Segments
6781
Get in app access to a subset of your application data by doing a basic search
6882
or typing an SQL query or implementing an API route.
6983

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">
7185

7286
### Dashboards
7387
Forest Admin is able to tap into your actual data to chart out your metrics
7488
using a simple UI panel, a SQL query or a custom API call.
7589

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">
7791

7892
### WYSIWYG
7993
The WYSIWYG interface saves you a tremendous amount of frontend development
8094
time using drag'n'drop as well as advanced widgets to build customizable views.
8195

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">
8397

8498
### Custom HTML/JS/CSS
8599
Code your own views using JS, HTML, and CSS to display your application data in
86100
a more appropriate way (e.g. Kanban, Map, Calendar, Gallery, etc.).
87101

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">
89103

90104
### Team-based permissions
91105
Without any lines of code, manage directly from the UI who has access or can
92106
act on which data using a team-based permission system.
93107

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">
95109

96110
### Third-party integrations
97111
Leverage data from third-party services by reconciling it with your
98112
application’s data and providing it directly to your Admin Panel. All your
99113
actions can be performed at the same place, bringing additional intelligence to
100114
your Admin Panel and ensuring consistency.
101115

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">
103117

104118
### Notes & Comments
105119
Assign your teammates to specific tasks, leave a note or simply comment a
106120
record, thereby simplifying collaboration all across your organization.
107121

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">
109123

110124
### Activity logs
111125
Monitor each action executed and follow the trail of modification on any data
112126
with an extensive activity log system.
113127

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">
126129

127130
## How to contribute
128131

0 commit comments

Comments
 (0)