-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add firebase nodejs demo (#218)
* feat: add firebase nodejs demo * feat: add firebase nodejs demo * chore: update podfile * chore: remove test * fix: lint issue
- Loading branch information
1 parent
7b41669
commit ba563b0
Showing
156 changed files
with
7,545 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Miscellaneous | ||
| *.class | ||
| *.log | ||
| *.pyc | ||
| *.swp | ||
| .DS_Store | ||
| .atom/ | ||
| .buildlog/ | ||
| .history | ||
| .svn/ | ||
| migrate_working_dir/ | ||
|
|
||
| # IntelliJ related | ||
| *.iml | ||
| *.ipr | ||
| *.iws | ||
| .idea/ | ||
|
|
||
| # The .vscode folder contains launch configuration and tasks you configure in | ||
| # VS Code which you may wish to be included in version control, so this line | ||
| # is commented out by default. | ||
| #.vscode/ | ||
|
|
||
| # Flutter/Dart/Pub related | ||
| **/doc/api/ | ||
| **/ios/Flutter/.last_build_id | ||
| .dart_tool/ | ||
| .flutter-plugins | ||
| .flutter-plugins-dependencies | ||
| .packages | ||
| .pub-cache/ | ||
| .pub/ | ||
| /build/ | ||
|
|
||
| # Symbolication related | ||
| app.*.symbols | ||
|
|
||
| # Obfuscation related | ||
| app.*.map.json | ||
|
|
||
| # Android Studio will place build artifacts here | ||
| /android/app/debug | ||
| /android/app/profile | ||
| /android/app/release | ||
|
|
||
| # asdf | ||
| .tool-versions | ||
|
|
||
| # secrets | ||
| app_config.dart |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| Creative Commons Legal Code | ||
|
|
||
| CC0 1.0 Universal | ||
|
|
||
| CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE | ||
| LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN | ||
| ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS | ||
| INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES | ||
| REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS | ||
| PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM | ||
| THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED | ||
| HEREUNDER. | ||
|
|
||
| Statement of Purpose | ||
|
|
||
| The laws of most jurisdictions throughout the world automatically confer | ||
| exclusive Copyright and Related Rights (defined below) upon the creator | ||
| and subsequent owner(s) (each and all, an "owner") of an original work of | ||
| authorship and/or a database (each, a "Work"). | ||
|
|
||
| Certain owners wish to permanently relinquish those rights to a Work for | ||
| the purpose of contributing to a commons of creative, cultural and | ||
| scientific works ("Commons") that the public can reliably and without fear | ||
| of later claims of infringement build upon, modify, incorporate in other | ||
| works, reuse and redistribute as freely as possible in any form whatsoever | ||
| and for any purposes, including without limitation commercial purposes. | ||
| These owners may contribute to the Commons to promote the ideal of a free | ||
| culture and the further production of creative, cultural and scientific | ||
| works, or to gain reputation or greater distribution for their Work in | ||
| part through the use and efforts of others. | ||
|
|
||
| For these and/or other purposes and motivations, and without any | ||
| expectation of additional consideration or compensation, the person | ||
| associating CC0 with a Work (the "Affirmer"), to the extent that he or she | ||
| is an owner of Copyright and Related Rights in the Work, voluntarily | ||
| elects to apply CC0 to the Work and publicly distribute the Work under its | ||
| terms, with knowledge of his or her Copyright and Related Rights in the | ||
| Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
|
||
| 1. Copyright and Related Rights. A Work made available under CC0 may be | ||
| protected by copyright and related or neighboring rights ("Copyright and | ||
| Related Rights"). Copyright and Related Rights include, but are not | ||
| limited to, the following: | ||
|
|
||
| i. the right to reproduce, adapt, distribute, perform, display, | ||
| communicate, and translate a Work; | ||
| ii. moral rights retained by the original author(s) and/or performer(s); | ||
| iii. publicity and privacy rights pertaining to a person's image or | ||
| likeness depicted in a Work; | ||
| iv. rights protecting against unfair competition in regards to a Work, | ||
| subject to the limitations in paragraph 4(a), below; | ||
| v. rights protecting the extraction, dissemination, use and reuse of data | ||
| in a Work; | ||
| vi. database rights (such as those arising under Directive 96/9/EC of the | ||
| European Parliament and of the Council of 11 March 1996 on the legal | ||
| protection of databases, and under any national implementation | ||
| thereof, including any amended or successor version of such | ||
| directive); and | ||
| vii. other similar, equivalent or corresponding rights throughout the | ||
| world based on applicable law or treaty, and any national | ||
| implementations thereof. | ||
|
|
||
| 2. Waiver. To the greatest extent permitted by, but not in contravention | ||
| of, applicable law, Affirmer hereby overtly, fully, permanently, | ||
| irrevocably and unconditionally waives, abandons, and surrenders all of | ||
| Affirmer's Copyright and Related Rights and associated claims and causes | ||
| of action, whether now known or unknown (including existing as well as | ||
| future claims and causes of action), in the Work (i) in all territories | ||
| worldwide, (ii) for the maximum duration provided by applicable law or | ||
| treaty (including future time extensions), (iii) in any current or future | ||
| medium and for any number of copies, and (iv) for any purpose whatsoever, | ||
| including without limitation commercial, advertising or promotional | ||
| purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each | ||
| member of the public at large and to the detriment of Affirmer's heirs and | ||
| successors, fully intending that such Waiver shall not be subject to | ||
| revocation, rescission, cancellation, termination, or any other legal or | ||
| equitable action to disrupt the quiet enjoyment of the Work by the public | ||
| as contemplated by Affirmer's express Statement of Purpose. | ||
|
|
||
| 3. Public License Fallback. Should any part of the Waiver for any reason | ||
| be judged legally invalid or ineffective under applicable law, then the | ||
| Waiver shall be preserved to the maximum extent permitted taking into | ||
| account Affirmer's express Statement of Purpose. In addition, to the | ||
| extent the Waiver is so judged Affirmer hereby grants to each affected | ||
| person a royalty-free, non transferable, non sublicensable, non exclusive, | ||
| irrevocable and unconditional license to exercise Affirmer's Copyright and | ||
| Related Rights in the Work (i) in all territories worldwide, (ii) for the | ||
| maximum duration provided by applicable law or treaty (including future | ||
| time extensions), (iii) in any current or future medium and for any number | ||
| of copies, and (iv) for any purpose whatsoever, including without | ||
| limitation commercial, advertising or promotional purposes (the | ||
| "License"). The License shall be deemed effective as of the date CC0 was | ||
| applied by Affirmer to the Work. Should any part of the License for any | ||
| reason be judged legally invalid or ineffective under applicable law, such | ||
| partial invalidity or ineffectiveness shall not invalidate the remainder | ||
| of the License, and in such case Affirmer hereby affirms that he or she | ||
| will not (i) exercise any of his or her remaining Copyright and Related | ||
| Rights in the Work or (ii) assert any associated claims and causes of | ||
| action with respect to the Work, in either case contrary to Affirmer's | ||
| express Statement of Purpose. | ||
|
|
||
| 4. Limitations and Disclaimers. | ||
|
|
||
| a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
| surrendered, licensed or otherwise affected by this document. | ||
| b. Affirmer offers the Work as-is and makes no representations or | ||
| warranties of any kind concerning the Work, express, implied, | ||
| statutory or otherwise, including without limitation warranties of | ||
| title, merchantability, fitness for a particular purpose, non | ||
| infringement, or the absence of latent or other defects, accuracy, or | ||
| the present or absence of errors, whether or not discoverable, all to | ||
| the greatest extent permissible under applicable law. | ||
| c. Affirmer disclaims responsibility for clearing rights of other persons | ||
| that may apply to the Work or any use thereof, including without | ||
| limitation any person's Copyright and Related Rights in the Work. | ||
| Further, Affirmer disclaims responsibility for obtaining any necessary | ||
| consents, permissions or other rights required for any use of the | ||
| Work. | ||
| d. Affirmer understands and acknowledges that Creative Commons is not a | ||
| party to this document and has no duty or obligation with respect to | ||
| this CC0 or use of the Work. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # PowerSync + Node.js + Firebase Auth + Flutter Demo: Todo List App | ||
|
|
||
| Demo app demonstrating use of the PowerSync SDK for Flutter together with a custom Node.js backend and using Firebase for user auth on the client. | ||
|
|
||
| This demo can run alongside the [powersync-nodejs-firebase-backend-todolist-demo](https://github.com/powersync-ja/powersync-nodejs-firebase-backend-todolist-demo) for testing and demo purposes. | ||
|
|
||
| We suggest you first set up the `powersync-nodejs-firebase-backend-todolist-demo` before setting up the client as shown in this repo. | ||
|
|
||
| # Running the app | ||
|
|
||
| Ensure you have [melos](https://melos.invertase.dev/~melos-latest/getting-started) installed. | ||
|
|
||
| 1. `cd demos/firebase-nodejs-todolist` | ||
| 2. `melos prepare` | ||
| 3. `cp lib/app_config_template.dart lib/app_config.dart` | ||
| 4. Insert your Supabase and PowerSync project credentials into `lib/app_config.dart` (See instructions below) | ||
| 5. `flutter run` | ||
|
|
||
| # Add your Firebase app | ||
| Follow the step found in [this page](https://firebase.google.com/docs/flutter/setup?platform=ios) from the Firebase docs to login to your Firebase account and to initialize the Firebase credentials. | ||
|
|
||
| # Set up Supabase project | ||
|
|
||
| Create a new Supabase project, and paste and run the contents of [database.sql](./database.sql) in the Supabase SQL editor. | ||
|
|
||
| It does the following: | ||
|
|
||
| 1. Create `lists` and `todos` tables. | ||
| 2. Create a publication called `powersync` for `lists` and `todos`. | ||
| 3. Enable row level security (RLS), allowing users to only view and edit their own data. | ||
| 4. Create a trigger to populate some sample data when a user registers. | ||
|
|
||
| We won't be using the Supabase Flutter SDK for this demo, but rather as a hosted PostgresSQL database that the app connects to. | ||
|
|
||
| # Set up PowerSync Instance | ||
|
|
||
| Create a new PowerSync instance, connecting to the database of the Supabase project. | ||
|
|
||
| Then deploy the following sync rules: | ||
|
|
||
| ```yaml | ||
| bucket_definitions: | ||
| user_lists: | ||
| # Separate bucket per todo list | ||
| parameters: select id as list_id from lists where owner_id = request.user_id() | ||
| data: | ||
| - select * from lists where id = bucket.list_id | ||
| - select * from todos where list_id = bucket.list_id | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # This file configures the analyzer, which statically analyzes Dart code to | ||
| # check for errors, warnings, and lints. | ||
| # | ||
| # The issues identified by the analyzer are surfaced in the UI of Dart-enabled | ||
| # IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be | ||
| # invoked from the command line by running `flutter analyze`. | ||
|
|
||
| # The following line activates a set of recommended lints for Flutter apps, | ||
| # packages, and plugins designed to encourage good coding practices. | ||
| include: package:flutter_lints/flutter.yaml | ||
|
|
||
| linter: | ||
| # The lint rules applied to this project can be customized in the | ||
| # section below to disable rules from the `package:flutter_lints/flutter.yaml` | ||
| # included above or to enable additional rules. A list of all available lints | ||
| # and their documentation is published at | ||
| # https://dart-lang.github.io/linter/lints/index.html. | ||
| # | ||
| # Instead of disabling a lint rule for the entire project in the | ||
| # section below, it can also be suppressed for a single line of code | ||
| # or a specific dart file by using the `// ignore: name_of_lint` and | ||
| # `// ignore_for_file: name_of_lint` syntax on the line or in the file | ||
| # producing the lint. | ||
| rules: | ||
| avoid_print: false # Uncomment to disable the `avoid_print` rule | ||
| # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule | ||
| # Additional information about this file can be found at | ||
| # https://dart.dev/guides/language/analysis-options | ||
|
|
||
| analyzer: | ||
| exclude: | ||
| - lib/firebase.dart # Exclude this as it imports a file that is not checked in |
Oops, something went wrong.