Skip to content

Commit 3996cb7

Browse files
ditmanditman
committed
Starting point for the Multi-platform Firestore Flutter Codelab
https://codelabs.developers.google.com/codelabs/friendlyeats-flutter Have fun!
1 parent 53accca commit 3996cb7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+3102
-161
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
lib/generated_plugin_registrant.dart
3535

3636
# Firebase
37+
.firebase
3738
.firebaserc
3839

3940
# Exceptions to above rules.

‎CONTRIBUTING.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Contributing to the Firebase FriendlyChat Codelab
2+
3+
We'd love for you to contribute to our source code and to make the Firebase FriendlyChat Codelab even better than it is today! Here are the guidelines we'd like you to follow:
4+
5+
- [Code of Conduct](#coc)
6+
- [Question or Problem?](#question)
7+
- [Issues and Bugs](#issue)
8+
- [Feature Requests](#feature)
9+
- [Submission Guidelines](#submit)
10+
- [Coding Rules](#rules)
11+
- [Signing the CLA](#cla)
12+
13+
## <a name="coc"></a> Code of Conduct
14+
15+
As contributors and maintainers of the Firebase FriendlyChat Codelab project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
16+
17+
Communication through any of Firebase's channels (GitHub, StackOverflow, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
18+
19+
We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.
20+
21+
If any member of the community violates this code of conduct, the maintainers of the Firebase Android Quickstarts project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.
22+
23+
If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at nivco@google.com.
24+
25+
## <a name="question"></a> Got a Question or Problem?
26+
27+
If you have questions about how to use the Firebase FriendlyChat Codelab, please direct these to [StackOverflow][stackoverflow] and use the `firebase` tag. We are also available on GitHub issues.
28+
29+
If you feel that we're missing an important bit of documentation, feel free to
30+
file an issue so we can help. Here's an example to get you started:
31+
32+
```
33+
What are you trying to do or find out more about?
34+
35+
Where have you looked?
36+
37+
Where did you expect to find this information?
38+
```
39+
40+
## <a name="issue"></a> Found an Issue?
41+
If you find a bug in the source code or a mistake in the documentation, you can help us by
42+
submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request
43+
with a fix.
44+
45+
See [below](#submit) for some guidelines.
46+
47+
## <a name="submit"></a> Submission Guidelines
48+
49+
### Submitting an Issue
50+
Before you submit your issue search the archive, maybe your question was already answered.
51+
52+
If your issue appears to be a bug, and hasn't been reported, open a new issue.
53+
Help us to maximize the effort we can spend fixing issues and adding new
54+
features, by not reporting duplicate issues. Providing the following information will increase the
55+
chances of your issue being dealt with quickly:
56+
57+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
58+
* **Motivation for or Use Case** - explain why this is a bug for you
59+
* **Browsers and Operating System** - is this a problem with all browsers or only IE9?
60+
* **Reproduce the Error** - provide a live example (using JSBin) or a unambiguous set of steps.
61+
* **Related Issues** - has a similar issue been reported before?
62+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
63+
causing the problem (line of code or commit)
64+
65+
**If you get help, help others. Good karma rulez!**
66+
67+
Here's a template to get you started:
68+
69+
```
70+
Browser:
71+
Browser version:
72+
Operating system:
73+
Operating system version:
74+
75+
What steps will reproduce the problem:
76+
1.
77+
2.
78+
3.
79+
80+
What is the expected result?
81+
82+
What happens instead of that?
83+
84+
Please provide any other information below, and attach a screenshot if possible.
85+
```
86+
87+
### Submitting a Pull Request
88+
Before you submit your pull request consider the following guidelines:
89+
90+
* Search [GitHub](https://github.com/firebase/codelab-friendlychat/pulls) for an open or closed Pull Request
91+
that relates to your submission. You don't want to duplicate effort.
92+
* Please sign our [Contributor License Agreement (CLA)](#cla) before sending pull
93+
requests. We cannot accept code without this.
94+
* Make your changes in a new git branch:
95+
96+
```shell
97+
git checkout -b my-fix-branch master
98+
```
99+
100+
* Create your patch, **including appropriate test cases**.
101+
* Follow our [Coding Rules](#rules).
102+
* Avoid checking in files that shouldn't be tracked (e.g `node_modules`, `gulp-cache`, `.tmp`, `.idea`). We recommend using a [global](#global-gitignore) gitignore for this.
103+
* Make sure **not** to include a recompiled version of the files found in `/css` and `/js` as part of your PR. We will generate these automatically.
104+
* Commit your changes using a descriptive commit message.
105+
106+
```shell
107+
git commit -a
108+
```
109+
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
110+
111+
* Build your changes locally to ensure all the tests pass:
112+
113+
```shell
114+
gulp
115+
```
116+
117+
* Push your branch to GitHub:
118+
119+
```shell
120+
git push origin my-fix-branch
121+
```
122+
123+
* In GitHub, send a pull request to `codelab-friendlychat:master`.
124+
* If we suggest changes then:
125+
* Make the required updates.
126+
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
127+
128+
```shell
129+
git rebase master -i
130+
git push origin my-fix-branch -f
131+
```
132+
133+
That's it! Thank you for your contribution!
134+
135+
#### After your pull request is merged
136+
137+
After your pull request is merged, you can safely delete your branch and pull the changes
138+
from the main (upstream) repository:
139+
140+
* Delete the remote branch on GitHub either through the GitHub Android UI or your local shell as follows:
141+
142+
```shell
143+
git push origin --delete my-fix-branch
144+
```
145+
146+
* Check out the master branch:
147+
148+
```shell
149+
git checkout master -f
150+
```
151+
152+
* Delete the local branch:
153+
154+
```shell
155+
git branch -D my-fix-branch
156+
```
157+
158+
* Update your master with the latest upstream version:
159+
160+
```shell
161+
git pull --ff upstream master
162+
```
163+
164+
## <a name="cla"></a> Signing the CLA
165+
166+
Please sign our [Contributor License Agreement][google-cla] (CLA) before sending pull requests. For any code
167+
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
168+
169+
*This guide was inspired by the [AngularJS contribution guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md).*
170+
171+
[github]: https://github.com/firebase/friendlychat
172+
[google-cla]: https://cla.developers.google.com
173+
[js-style-guide]: http://google.github.io/styleguide/javascriptguide.xml
174+
[py-style-guide]: http://google.github.io/styleguide/pyguide.html
175+
[jsbin]: http://jsbin.com/
176+
[stackoverflow]: http://stackoverflow.com/questions/tagged/firebase
177+
[global-gitignore]: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1-
# friendlyeats-flutter
2-
A cross-platform Flutter port of the "Friendlyeats" Cloud Firestore demo
1+
# FlutterFire Codelab: Friendly Eats
2+
A cross-platform Flutter port of the "Friendly Eats" Firestore codelab.
3+
4+
This is the source code for the FlutterFire Friendly Eats codelab. It includes
5+
start and end versions of the required code.

0 commit comments

Comments
 (0)