Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The Quick Start guide does not tell you what a schema is, or where to get one #1556

Open
mradamgbeck opened this issue Jan 28, 2024 · 7 comments
Open

The Quick Start guide does not tell you what a schema is, or where to get one #1556

mradamgbeck opened this issue Jan 28, 2024 · 7 comments

Comments

@mradamgbeck
Copy link

Steps to Reproduce

  1. Try to follow the quick start guide from a new flutter project.
  2. Get to step 4 where it has you set up a new instance
  3. realize UserSchema doesn't exist and you don't know how to get one

Code sample

final dir = await getApplicationDocumentsDirectory();
final isar = await Isar.open(
  [UserSchema], // <-----------------------------------------    this right here. 
  directory: dir.path,
);

Details

  • Platform: any flutter platform
  • Flutter version: 4.0.0
  • Isar version: 3.1.0
  • [x ] I searched for similar issues already
  • [x ] I filled the details section with the exact device model and version
  • [x ] I am able to provide a reproducible example
@Cierra-Runis
Copy link

Did you generate code file such as user.g.dart by running build_runner?

@mradamgbeck
Copy link
Author

mradamgbeck commented Jan 28, 2024 via email

@oppware
Copy link

oppware commented Feb 5, 2024

Have you watch one of the tutorials?
https://isar.dev/tutorials/quickstart.html#other-resources
It's all in there 🤷🏼‍♂️

@mradamgbeck
Copy link
Author

mradamgbeck commented Feb 5, 2024 via email

@oppware
Copy link

oppware commented Feb 6, 2024 •
edited
Loading

It is not my product nor my documentation...I was just trying to help.

And generating a *.g.dart file and including it in your class file is not an isar "thing", it's standard flutter/dart practice and isar is just using it like so many other tools and packages dealing with json.

@Cierra-Runis
Copy link

Have you watch one of the tutorials?
https://isar.dev/tutorials/quickstart.html#other-resources
It's all in there 🤷🏼‍♂️

In fact, Chinese version of doc add one more sentence to declare where scheme is, which is better than English one.

@mradamgbeck
Copy link
Author

mradamgbeck commented Feb 6, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mradamgbeck @Cierra-Runis @oppware