Skip to content

Commit 9fffcbb

Browse files
committed
Version 0.3.1.
1 parent da3c21b commit 9fffcbb

File tree

3 files changed

+21
-14
lines changed

3 files changed

+21
-14
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In a web browser, go to the url [http://localhost:3000/](http://localhost:3000/)
3535
For the REST endpoints, you also need to install and run [Evolutility-Server-Node](https://github.com/evoluteur/evolutility-server-node) which provides the matching REST endpoints based on the same metadata.
3636

3737

38-
## Configuration
38+
## Setup
3939

4040
Configurations options are specified in the file [/src/config.js](https://github.com/evoluteur/evolutility-ui-react/blob/master/src/config.js). They apply to all apps (app specific options are specified in models).
4141

@@ -55,10 +55,10 @@ For any object, a single model defines UI elements across views in a simple decl
5555

5656
Evolutility-UI-React provides 2 types of view:
5757

58-
* Views for a model: [Browse](#browse), [Edit](#edit).
59-
* Views for a collection: [List](#list), [Cards](#cards), [Charts](#charts), [Stats](#stats).
58+
* Views for One - a single record: [Browse](#browse), [Edit](#edit).
59+
* Views for Many - a collection of records: [List](#list), [Cards](#cards), [Charts](#charts), [Stats](#stats).
6060

61-
Notes: Views for actions will come later.
61+
Notes: Views for actions (search, filter, export) will come later.
6262

6363
A large part of the API (methods, options and events) is common to all views. Some views have additional API.
6464

@@ -125,6 +125,10 @@ View: [http://localhost:3000/comics/stats](http://localhost:3000/comics/stats)
125125

126126
Each model describe an object and its list of fields. A single model is used for all views (Browse, Edit, List, Cards...).
127127

128+
For any object, all UI views (List, Cards, Edit, Charts...) share the same model.
129+
All Fields are present in the Edit and Browse views. Fields can be flagged as "inMany" to be included in List, Cards, and Charts views.
130+
131+
128132
### Object
129133

130134
| Property | Meaning |
@@ -170,7 +174,7 @@ Objects have fields.
170174
<a name="Group"></a>
171175
### Group
172176

173-
Groups are used to visually divide Fields (in Edit and Browse views).
177+
Groups are used to separate Fields into panels in the Edit and Browse views.
174178

175179
| Property | Meaning |
176180
|--------------|---------------------------------------|
@@ -182,8 +186,9 @@ Groups are used to visually divide Fields (in Edit and Browse views).
182186
| header | Text to be displayed at the top of the group (just below the group title).|
183187
| footer | Text to be displayed at the bottom of the group. |
184188

185-
Note: Groups are optional. By default a single group holds all fields.
186-
189+
Notes:
190+
- Groups are optional. By default a single group holds all fields.
191+
- Groups are positioned based on their "width" property the same way than fields are positioned inside groups.
187192

188193
<a name="Collection"></a>
189194
### Collection
@@ -312,11 +317,13 @@ More sample models: [To-do list](https://github.com/evoluteur/evolutility-ui-rea
312317
[Wine cellar](https://github.com/evoluteur/evolutility-ui-react/blob/master/src/models/pim/winecellar.js).
313318

314319

315-
## Other implementations of Evolutility
320+
## Evolutility backend
316321

317-
[Evolutility-UI-jQuery](https://github.com/evoluteur/evolutility-ui-jquery) - Model-driven Web UI for CRUD using jQuery and Backbone (for REST or localStorage).
322+
[Evolutility-Server-Node](https://github.com/evoluteur/evolutility-server-node) provides REST or GraphQL end-points for Evolutility-UI-React using the same models.
323+
324+
### Earlier implementations for other stacks
318325

319-
[Evolutility-Server-Node](https://github.com/evoluteur/evolutility-server-node) - RESTful Micro-ORM for CRUD and more, written in Javascript, using Node.js, Express, and Postgres.
326+
[Evolutility-UI-jQuery](https://github.com/evoluteur/evolutility-ui-jquery) - Model-driven Web UI for CRUD using jQuery and Backbone (for REST or localStorage).
320327

321328
[Evolutility-ASP.net](https://github.com/evoluteur/evolutility-asp.net) - Lightweight CRUD framework for heavy lifting with ASP.net and Microsoft SQL-Server.
322329

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "evolutility-ui-react",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "Model-driven Web UI for CRUD and more",
55
"repository": {
66
"type": "git",

src/pages/Home.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ export default class Home extends React.PureComponent {
6868
</p>
6969

7070
<p>Sample RESTful API: {' '}
71-
7271
<a target="api" href={apiPathFull}>API discovery</a>, {' '}
73-
7472
<a target="api" href={apiPathFull+'todo'}>To-Do list</a>, {' '}
7573
<a target="api" href={apiPathFull+'contact'}>Address Book</a>, {' '}
7674
<a target="api" href={apiPathFull+'comics'}>Graphic Novels inventory</a>, {' '}
7775
<a target="api" href={apiPathFull+'restaurant'}>Restaurants list</a>, {' '}
78-
<a target="api" href={apiPathFull+'winecellar'}>Wine Cellar</a>.
76+
<a target="api" href={apiPathFull+'winecellar'}>Wine Cellar</a>{' '}
77+
or <a target="api" href="http://localhost:2000/graphql">GraphQL UI</a>.
7978
</p>
79+
8080
</div>
8181

8282
</div>

0 commit comments

Comments
 (0)