You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-2
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,32 @@ However, the ObjectBox core supports many more features, e.g. queries, indexing,
9
9
To bring all these features to Dart, we're asking the community to help out. PRs are more than welcome!
10
10
The ObjectBox team will try its best to guide you and answer questions.
11
11
12
+
### Open Development Process
13
+
14
+
This project is completely managed here on GitHub using its [issue tracker](https://github.com/objectbox/objectbox-dart/issues) and [project boards](https://github.com/objectbox/objectbox-dart/projects).
15
+
16
+
To prepare an upcoming version, we create a (Kanban like) board for it.
17
+
Once it is decided which features and fixes go into the version, the according issues are added to the board.
18
+
Issues on the board are referred to as "cards" which move from left to right:
19
+
20
+
* New cards start in the "To Do" column.
21
+
Within the column, cards are ordered: more important tasks should be above less important ones.
22
+
* Once somebody starts on a task, the according card is moved to "In progress".
23
+
Also, please assign yourself to the issue.
24
+
* Once a task is considered complete (e.g. PR is made), put it in the "Review" column.
25
+
* Once another person had a look and is happy, the task is finally moved to "Done"
26
+
27
+
Anyone can contribute in this process. Look for tasks having a **"help wanted"** tag.
28
+
29
+
### Feedback
30
+
12
31
Also, please let us know your feedback by opening an issue:
13
32
for example, if you experience errors or if you have ideas for how to improve the API.
14
33
Thanks!
15
34
16
35
Getting started
17
36
---------------
18
-
To try out the demo code in this repository, follow these:
37
+
To try out the demo code in this repository, follow these steps:
19
38
20
39
1. Install [objectbox-c](https://github.com/objectbox/objectbox-c) system-wide: `bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh)` (answer Y when it asks about installing to /usr/lib).
21
40
2. Back in this repository, run `pub get` to download all Dart dependencies.
@@ -38,6 +57,10 @@ New (not yet persisted) objects typically have _Id_ value of `0` or `null`: call
38
57
39
58
### Example
40
59
60
+
*Note:* specifying the (meta model) IDs in annotations manually is a temporary quick solution.
61
+
In a later version, you won't have to do this the and e.g. `@Property(id: 2, uid: 1002)` can be dropped completely.
62
+
Technically, we need to setup [build time tools for Dart](https://github.com/objectbox/objectbox-dart/issues/3) for automatic management of the meta model IDs.
63
+
41
64
```dart
42
65
import "../lib/objectbox.dart";
43
66
@@ -79,4 +102,26 @@ These language bindings currently serve as an example for this Dart implementati
79
102
80
103
Internally, ObjectBox uses [FlatBuffers](https://google.github.io/flatbuffers/) to store objects.
81
104
There are two basic ways to make the conversion: generated binding code, or implicit FlatBuffers conversion.
82
-
In order to require as little setup as possible and to define entity classes directly in Dart code, the latter is used in this binding.
105
+
The latter is used at the moment (helped us to get started quickly).
106
+
A future version will exchange that with code generation.
107
+
108
+
Changelog
109
+
---------
110
+
[CHANGELOG.md](CHANGELOG.md)
111
+
112
+
License
113
+
-------
114
+
Copyright 2019 ObjectBox Ltd. All rights reserved.
115
+
116
+
Licensed under the Apache License, Version 2.0 (the "License");
117
+
you may not use this file except in compliance with the License.
118
+
You may obtain a copy of the License at
119
+
120
+
http://www.apache.org/licenses/LICENSE-2.0
121
+
122
+
Unless required by applicable law or agreed to in writing, software
123
+
distributed under the License is distributed on an "AS IS" BASIS,
124
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
125
+
See the License for the specific language governing permissions and
0 commit comments