diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fd50339 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 duapp.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 85baefa..3a4d43f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -# Expo + Firebase Auth + UI-kitten Starter Kit +# Expo + Firebase Auth + UI Kitten Starter Kit -This is a boilerplate for starting an Expo project with Login/Register +This is a boilerplate for starting an Expo project with Login/Register flows ready + +## Features + +- [Expo](https://expo.dev) with JavaScript +- [UI Kitten](https://akveo.github.io/react-native-ui-kitten/) as UI library +- [Firebase](https://firebase.google.com) integration (No Analytics yet) +- Localization (i18n) ready +- `.env` Environment override +- Easy form development by [Formik](https://formik.org) and [Yup](https://github.com/jquense/yup) +- Linter and formatter by [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) and [Prettier](https://prettier.io) +- Testing support with `jest-expo` and [React Native Testing Library](https://github.com/callstack/react-native-testing-library) +- GitHub CI workflow ## Requirement @@ -18,6 +30,8 @@ FIREBASE_STORAGE_BUCKET="project-id.appspot.com" FIREBASE_MESSAGING_SENDER_ID="sender-id" ``` +Add Email/Password Sign-in provider in Firebase Authentication. + ## Development ### Getting Started diff --git a/package.json b/package.json index 299be70..a5c54eb 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,23 @@ { + "name": "expo-fire-kitten", + "version": "1.0.0", + "description": "Expo boilerplate with Login/Register ready (Firebase + UI Kitten)", + "keywords": [ + "expo", + "boilerplate", + "firebase", + "ui-kitten" + ], + "author": "Vivo Xu ", + "license": "MIT", + "repository": { + "type": "git", + "url": "git+https://github.com/duapp/expo-fire-kitten.git" + }, + "bugs": { + "url": "https://github.com/duapp/expo-fire-kitten/issues" + }, + "homepage": "https://github.com/duapp/expo-fire-kitten#readme", "main": "node_modules/expo/AppEntry.js", "scripts": { "start": "expo start", @@ -72,7 +91,6 @@ "!**/jest.setup.js" ] }, - "private": true, "lint-staged": { "*.{js,jsx}": "eslint --cache --fix" }