From bac787c2e07b8817e1f4d01f8de24bafb9a9e548 Mon Sep 17 00:00:00 2001 From: Rishichandra Wawhal Date: Tue, 20 Mar 2018 18:51:22 +0530 Subject: [PATCH 1/8] Create LICENSE --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 4308ff041c2e10a44fd6cb6a1850a9e4b17bee61 Mon Sep 17 00:00:00 2001 From: anandfeb25 Date: Tue, 20 Mar 2018 19:19:50 +0530 Subject: [PATCH 2/8] Update README.md --- README.md | 53 ++++++++++++++++++++--------------------------------- 1 file changed, 20 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 1338e50..d80db24 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,23 @@ # React Native Auth Boilerplate -This is a React Native boilerplate with auth already implemented. It uses [Nativebase](https://nativebase.io) for UI and [Hasura APIs](https://hasura.io/features/auth) for backend. +This is a React Native boilerplate with auth already implemented. It uses [Nativebase](https://nativebase.io) for the UI and [Hasura APIs](https://hasura.io/features/auth) for the backend. -![gif](https://raw.githubusercontent.com/hasura/react-native-auth-boilerplate/master/readme-assets/ios/ios_gif.gif) - -> You can also use it without Hasura, but you will have to write your own backend implementation. - -You can use it with and without the Expo SDK. - -## Try out on Expo - -Scan this QR Code from your Expo application to try out this application. +This has been open sourced by the Hasura team. There are instructions below in case you wish to use this boilerplate without the Hasura APIs. -![gif](https://raw.githubusercontent.com/hasura/react-native-auth-boilerplate/master/readme-assets/expo.png) +![gif](https://raw.githubusercontent.com/hasura/react-native-auth-boilerplate/master/readme-assets/ios/ios_gif.gif) ## Who should use this? -- Fullstack React Native developers looking to start building an app with authentication already covered. -- Developers at a hackathon trying to build React Native applications from scratch. -- Developers who want a working authentication backend to further customize it as per their requirements. +- React Native developers looking to start building an app with authentication already covered. You can modify both the UI and the backend logic to customize it per your own requirements. + - Developers trying to use Hasura with React Native. -- Developers who need basic authentication UI and want to write the backend logic themselves. ## Getting Started -### With Hasura APIs +## Using this with the Hasura APIs -Make sure to have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura-cli.html) installed. +Make sure you have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura-cli.html) installed. - Clone the repo and `cd` into it. @@ -35,9 +25,9 @@ Make sure to have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura $ git clone https://github.com/hasura/react-native-auth-boilerplate ``` -- `cd` into expo directory if you wish to use the expo SDK or `cd` into vanilla directory +- `cd` into expo directory if you wish to use the expo SDK, or `cd` into the vanilla react native app directory -- Quickstart the base Hasura project and apply the configuration of the project to the newly created [Hasura cluster](https://docs.hasura.io/0.15/manual/cluster/index.html) +- Quickstart with the base Hasura project and apply the configuration of the project to the newly created [Hasura cluster](https://docs.hasura.io/0.15/manual/cluster/index.html), as per the instructions below. ```bash $ hasura quickstart base @@ -46,16 +36,16 @@ Make sure to have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura $ git push hasura master ``` -> The `hasura quickstart` command clones a base Hasura project with basic configuration and creates a free tier [Hasura cluster](https://docs.hasura.io/0.15/manual/cluster/index.html). Running a `git push` to the `hasura` remote applies the configuration from the project (here base) to the cluster. +> The `hasura quickstart` command clones a base Hasura project with basic configuration and creates a free tier [Hasura cluster](https://docs.hasura.io/0.15/manual/cluster/index.html). Running a `git push` to the `hasura` remote applies the configuration from the project (the base project in this case) to the cluster. -- You will obtain a cluster name after running `hasura quickstart`. Go back to the expo (or vainalla) directory and set this clusterName in `Hasura.js`. Also set `useHasuraApis` to true. +- You will obtain a cluster name after running `hasura quickstart`. Go back to the expo (or vanilla) directory and set this clusterName in `Hasura.js`. Also set `useHasuraApis` to true. ```javascript - const clusterName = "clustername44"; + const clusterName = ""; const useHasuraApis = true; ``` -- Install node modules and run the app. +- Install node modules. ```bash $ npm install @@ -78,26 +68,23 @@ Make sure to have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura $ react-native run-ios ``` -> To get started with React Native development using Hasura, head to [hasura/hello-react-native](https://hasura.io/hub/projects/hasura/hello-react-native/) on [Hasura hub](https://hasura.io/hub). +### Using this without the Hasura APIs -### Without Hasura APIs +You will have to configure your own login methods if you are not using the Hasura APIs. Check the [detailed instructions](#detailed-instructions-for-usage) for more information. -You have to configure login methods if you are not using Hasura APIs. Check the [detailed instructions](#detailed-instructions-for-usage) for about configuration. +## Detailed Instructions +- For using the application with Expo SDK, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/expo)for more detailed instructions. -## Detailed Instructions for Usage -- For using the application with Expo SDK, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/expo) - -- For using vanilla react native, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/vanilla) +- For using this with vanilla react native, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/vanilla) for more detailed instructions. ## Contribute -We will be very glad to receive contributions from the community. Check [issues](https://github.com/hasura/react-native-boilerplate/issues) with the label "help wanted" and submit a pull request. - -If you have a bug report or a feature request, please [open an issue](https://github.com/hasura/react-native-boilerplate/issues). +React Native Auth boilerplate is an open source project licensed under Apache License 2.0. +Contributions are welcome. ## Gallery From 96af718980a9f02f8c769e94ff947a876ad458eb Mon Sep 17 00:00:00 2001 From: anandfeb25 Date: Tue, 20 Mar 2018 19:21:20 +0530 Subject: [PATCH 3/8] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d80db24..558e25d 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,9 @@ Make sure you have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasur ### Using this without the Hasura APIs -You will have to configure your own login methods if you are not using the Hasura APIs. Check the [detailed instructions](#detailed-instructions-for-usage) for more information. +You will have to configure your own login methods if you are not using the Hasura APIs. -## Detailed Instructions - -- For using the application with Expo SDK, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/expo)for more detailed instructions. +- For using the application with Expo SDK, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/expo) for more detailed instructions. - For using this with vanilla react native, [click here](https://github.com/hasura/react-native-auth-boilerplate/blob/master/vanilla) for more detailed instructions. From f2176b807d1420052c81814957c3c6f800bcef61 Mon Sep 17 00:00:00 2001 From: anandfeb25 Date: Tue, 20 Mar 2018 19:30:31 +0530 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 558e25d..a203dfe 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This has been open sourced by the Hasura team. There are instructions below in c ## Getting Started -## Using this with the Hasura APIs +### Using this with the Hasura APIs Make sure you have [hasura CLI](https://docs.hasura.io/0.15/manual/install-hasura-cli.html) installed. From 5ff849715f4729850a904e9487e2ed26ff6017a8 Mon Sep 17 00:00:00 2001 From: anandfeb25 Date: Tue, 20 Mar 2018 19:35:54 +0530 Subject: [PATCH 5/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a203dfe..0101903 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is a React Native boilerplate with auth already implemented. It uses [Nativebase](https://nativebase.io) for the UI and [Hasura APIs](https://hasura.io/features/auth) for the backend. -This has been open sourced by the Hasura team. There are instructions below in case you wish to use this boilerplate without the Hasura APIs. +This has been created as an open-source boilerplate by the Hasura team. There are instructions below in case you wish to use this boilerplate without the Hasura APIs. ![gif](https://raw.githubusercontent.com/hasura/react-native-auth-boilerplate/master/readme-assets/ios/ios_gif.gif) From 1a9673031dcc07f7c878471742362809cb654b20 Mon Sep 17 00:00:00 2001 From: anandfeb25 Date: Tue, 20 Mar 2018 19:43:05 +0530 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0101903..0551994 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This has been created as an open-source boilerplate by the Hasura team. There ar ## Who should use this? -- React Native developers looking to start building an app with authentication already covered. You can modify both the UI and the backend logic to customize it per your own requirements. +- Fullstack React Native developers looking to start building an app with authentication already covered. You can modify both the UI and the backend logic to customize it per your own requirements. - Developers trying to use Hasura with React Native. From f61ed036523ca9925b5194ae6452a9f3f543ca13 Mon Sep 17 00:00:00 2001 From: Rishichandra Wawhal Date: Tue, 20 Mar 2018 20:14:04 +0530 Subject: [PATCH 7/8] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5ae5949 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at build@hasura.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ From 913695ab57c1fd32050ed560ebed6c6db86aa095 Mon Sep 17 00:00:00 2001 From: Rishichandra Wawhal Date: Tue, 20 Mar 2018 20:38:07 +0530 Subject: [PATCH 8/8] Create CONTRIBUTING.md --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..28de9e4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +Follow the guidelines below to start contributing to **react-native-auth-boilerplate**. + +1. Choose an issue to work on. If you have a new feature request or a bug report, add a new issue. + +2. Fork the repo to /react-native-auth-boilerplate + +3. Clone the repo. + +``` +$ git clone git@github.com:/react-native-auth-boilerplate.git +``` + +4. Make your changes and test thoroughly. + +5. Pull the changes upstream + +``` +$ git pull https://github.com/hasura/react-native-auth-boilerplate.git master +``` + +6. Resolve the merge conflicts if there are any. + +7. Submit a pull request referencing the issue your work is associated with. + +It will be merged after testing by the maintaining team. + +Thanks for your interest in contributing to the project. :)