First Time contribution

[Ahmed-elshorbagy]

I can help to speed up the process .
I can start with cloud firstore or whatever the next step in the roadmap
this is my first time in open source projects
can anyone guide me
thanks in advance

[peterBrxwn]

Same here. Me and my team (3 other developers ~2 yrs experience with flutter, dart and javascript) would love to help. But we have no idea where to start.

[TimWhiting]

Glad to see interest in contributing! Happy to help answer questions.

[TimWhiting]

Here is the Roadmap.
#52

I contributed the cloud_functions api a while back and I can share what my opinion is and what I learned, but I'll defer to @pr-Mais who seems to be leading this effort.

@pr-Mais is still working on finishing auth. But the main pieces should be available in core / auth to start working on the next steps.

I would pick one of the simple next step packages listed in the roadmap (copied below) and let @pr-Mais know which one you are working on so that work is not duplicated:

• Installations
• Remote Config
• Cloud Storage
• Analytics

I encourage working on one of the simpler packages that is next in the Roadmap and not tackling something huge like database or firestore for a few reasons:

• Learning how to contribute to this project
• Getting feedback on how you are structuring the code via PRs
• It would be easy to get discouraged trying to work on a massive thing like database or firestore by yourself
• Database and firestore are not the priority in the roadmap and are thus less likely to receive prompt reviews
• The sooner we get these packages done, the sooner more effort and priority can be placed on database and firestore

Next I would look at how the existing projects are structured

• core is simple and doesn't involve external APIs so it wouldn't be helpful
• functions is rather simple as well, and so it is structured a little more simply
• auth is very complex, but as such it has a more structured approach

Functions was simple enough that I got it done in just a couple of PRs

• Try creating one PR for just the basic user facing interfaces and class definitions (leave all the functions throwing Unimplemented errors). Use the fluttefire plugin platform interface package and main plugin package to understand how to structure the user facing API
• Next create a PR with an API class wrapping the internal googleapi calls. (Depending on whether the package has a corresponding api in https://pub.dev/packages/googleapis this may be more or less needed), functions delegates calls to user defined endpoints so I did not have a separate API class when I implemented that.
• Next start implementing the functions a couple at a time, with corresponding tests. Look at existing tests for inspiration. Create one PR for a couple of functions to make it easier to review the PR. You can use the javascript sdk as a reference for implementing the logic.

More detailed steps with links to auth examples:

• Create a dart only package
• Create a flutter desktop project (not a plugin, just a package) that depends on the dart only package & the platform interface package from the flutterfire sdk and mark it as implementing that platform interface in the pubspec.yaml for the desktop platforms auth example
• Create an API that is a light wrapper around the googleapi endpoints auth example
• Create a class that mimics the api of the fluttefire version of the plugins auth example
• Create a class in the desktop package that implements the flutterfire platform interface of the package and delegates to the dart package for the implementation auth example
• You might have to implement other platform interfaces as well depending on the package which should delegate to the dart package classes. auth example
• Additionally you'll probably have to map the classes that do not have platform interfaces that you need to implement but are duplicated across the pure-dart and the platform interface. auth example

[TimWhiting]

It's looking good. If you open a draft pull request to indicate that you are working on it and make it easier to provide feedback, that would be nice.

A few initial items of feedback.

• Include the copyright at the top of each of the dart files:

// Copyright 2022 Invertase Limited. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file.

• Copy the LICENSE from one of the other packages.
• The first versions of these packages have typically been 0.1.0-dev.0 @pr-Mais is that still what you want to be doing?
• Look into functions or auth packages to get a basic description template for putting in the pubspec.yaml meta /description information.
• The pure dart package files should not have a Platform / _delegate (because the dart code should work on all platforms)
  For example

class Reference {
  Reference._(this.storage, this._delegate) {
    ReferencePlatform.verifyExtends(_delegate);
  }

  ReferencePlatform _delegate;
...

should be:

class Reference {
  Reference._(this.storage);
...

There is a couple of places this needs to change.

In the desktop package you will need to extend the platform interfaces though: (Yes, import the platform interface package in the desktop package)

class FirebaseDesktopReference extends ReferencePlatform {
  /// Creates a [ReferencePlatform] that is implemented using pure dart.
  FirebaseDesktopReference(FirebaseStoragePlatform storage, String path)
      : super(storage, path);
...

See the implementation of the platform interfaces using a method channel, you will be essentially doing this, but connecting it to the pure dart package.

• You can copy the example app from the flutterfire repository to test locally the desktop implementation. Just add a path dependency on the desktop package. I believe flutter will automatically register the desktop implementation of plugin for you when you build for desktop.

I hope that answers your questions

[pr-Mais]

Hello, thanks @TimWhiting on the amazing instructions, everything mentioned is correct.
Regarding the version, once the work is in a good shape for a preview release, the first release will have the version number 0.1.0-dev.0.

Further feedback and discussion will be held on the PR, thanks @Ahmed-elshorbagy for initiating it 😄

[TimWhiting]

Thanks for the motivation to get involved in this project again. It is good to see other open source contributors actively involved! I've started firebase_remote_config, and will developing that PR as I find time for it.

[Ahmed-elshorbagy]

thansks @pr-Mais @TimWhiting i will update my pr with new files today i hope you can give feedback i intend to finish the whole project by the end of next week

[TimWhiting]

By the way there is also https://github.com/invertase/dart_firebase_apis that @Salakar has generated for the firebase apis based on the google discovery documents for those APIs. They do not cover the whole API surface that the javascript sdk covers from what I saw when I glanced at it, but they cover a decent bit depending on the firebase package, and could be a good place to start when working on the API interface portion.