Skip to content

geoseong/study-amplify-with-react-native

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 

Repository files navigation

AWSKRUG Community Day 2020 Amplify Demo

KeyNote

AWSKRUG Community Day Seoul 2020 - Amplify with React-Native(Koean)

Prerequisites

Step

  • You can read this 'Step' below with watching the recorded tutorial videos to make this instructions understandable
  1. $ expo init

    1. select blank in Managed workflow
    2. enter the project's name and slug. you can type Tab and Shift + Tab key to switch the cursor
    3. type Y to install expo project's dependency
    ? Choose a template: (Use arrow keys)
      ----- Managed workflow -----
    ❯ blank                 a minimal app as clean as an empty canvas 
      blank (TypeScript)    same as blank but with TypeScript configuration 
      tabs                  several example screens and tabs using react-navigation 
      ----- Bare workflow -----
      minimal               bare and minimal, just the essentials to get you started
      minimal (TypeScript)  same as minimal but with TypeScript configuration 
    
    ? Please enter a few initial configuration values.
      Read more: https://docs.expo.io/versions/latest/workflow/configuration/ › 100% completed
      {
        "expo": {
          "name": "JustApp",
          "slug": "awskrug-amplify-just-app"
        }
      }
    
    ? Yarn v1.21.1 found. Use Yarn to install dependencies? (Y/n) Yes
    
    ...
    yarn install v1.21.1
    installing proess...
    ...
    
    ✨  Done in 30.45s.
    
    Your project is ready at /Users/****/JustApp
    
    To get started, you can type:
    
      cd JustApp
      yarn start
    
  2. install react-navigation

    $ expo install react-navigation react-native-gesture-handler react-native-reanimated react-native-screens react-native-safe-area-context
  3. install react-navigation-stack for Stack Navigation

    $ yarn add react-navigation-stack @react-native-community/masked-view
  4. install expo-image-picker

    $ expo install expo-image-picker
    
  5. install buffer

    $ yarn add buffer
    
  6. clone the repository to other place and copy src folder and overwrite App.js

    $ cd ../
    $ git clone https://github.com/geoseong/study-amplify-with-react-native.git
    $ cp -r handson/src ../JustApp/src
    $ cp handson/App.js ../JustApp/App.js 
    
  7. check out navigation's structure

    • Stack Navigator: stack.js
      • Main: Main.js
      • CreatePost: CreatePost.js
    • Switch Navigator: switch.js
      • AuthLoading: AuthLoadingScreen.js
      • StackNav: Stack Navigator
  8. Expo Debugging

    $ expo start --android
    or
    $ yarn android
  9. amplify init

    $ amplify init
    
    Scanning for plugins...
    Plugin scan successful
    Note: It is recommended to run this command from the root of your app directory
    ? Enter a name for the project "JustApp"
    ? Enter a name for the environment "dev"
    ? Choose your default editor: "Visual Studio Code"
    ? Choose the type of app that you're building javascript
    Please tell us about your project
    ? What javascript framework are you using "react-native"
    ? Source Directory Path:  "src"
    ? Distribution Directory Path: "/" (just Enter)
    ? Build Command:  "npm run-script build" (just Enter)
    ? Start Command: "npm run-script start" (just Enter)
    Using default provider  awscloudformation
    
    For more information on AWS Profiles, see:
    https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html
    
    ? Do you want to use an AWS profile? (Y/n) "Y"
    
    ? Please choose the profile you want to use "{your profile name}"
    Adding backend environment dev to AWS Amplify Console app: d2egeeayc0vvkl
    ⠦ Initializing project in the cloud...
    
    CREATE_IN_PROGRESS amplify-justapp-dev-234651 AWS::CloudFormation::Stack Tue Jan 14 2020 23:46:54 GMT+0900 (Korean Standard Time) User Initiated             
    CREATE_IN_PROGRESS DeploymentBucket           AWS::S3::Bucket            Tue Jan 14 2020 23:46:57 GMT+0900 (Korean Standard Time) 
    
    ...
    
    ✔ Initialized provider successfully.
    Initialized your environment successfully.
    
    Your project has been successfully initialized and connected to the cloud!
    
  10. amplify add api

    • authorization type: API key
    • edit schema.graphql with @model directive
      $ amplify add api
      
      ? Please select from one of the below mentioned services: GraphQL
      ? Provide API name: "justapp"
      ? Choose the default authorization type for the API "API key"
      ? Enter a description for the API key: ""
      ? After how many days from now the API key should expire (1-365): "7"
      ? Do you want to configure advanced settings for the GraphQL API "No, I am done."
      ? Do you have an annotated GraphQL schema? "No"
      ? Do you want a guided schema creation? "Yes"
      ? What best describes your project: "One-to-many relationship (e.g., “Blogs” with “Posts” and “Comments”)"
      ? Do you want to edit the schema now? (Y/n) "Y"
      
      Please edit the file in your editor: "/Users/{your path}/JustApp/amplify/backend/api/justapp/schema.graphql"
      
      ? Press enter to continue 
      
    • schema.graphql
      type Post @model {
        id: ID!
        content: String!
        likes: Int!
        author: String!
        createdAt: String!
        updatedAt: String!
      }
    • press Enter Key in cli and creating API's step continues
      The following types do not have '@auth' enabled. Consider using @auth with @model
          - Post
      Learn more about @auth here: https://aws-amplify.github.io/docs/cli-toolchain/graphql#auth 
      
      GraphQL schema compiled successfully.
      
      Edit your schema at /Users/{your path}/JustApp/amplify/backend/api/justapp/schema.graphql or place .graphql files in a directory at /Users/{your path}/JustApp/amplify/backend/api/justapp/schema
      Successfully added resource justapp locally
      
  11. amplify mocking and testing

    • running Amplify CLI amplify mock
      $ amplify mock
      
      ? Choose the code generation language target "javascript"
      ? Enter the file name pattern of graphql queries, mutations and subscriptions "src/graphql/**/*.js"
      ? Do you want to generate/update all possible GraphQL operations - queries, mutations and subscriptions "Yes"
      ? Enter maximum statement depth [increase from default if your schema is deeply nested] "2"
      ✔ Generated GraphQL operations successfully and saved at src/graphql
      AppSync Mock endpoint is running at http://xxxxx:20002
      
    • insert some data with using GraphQL's mutation query
  12. install amplify framework

    • cli
      $ yarn add aws-amplify
      $ yarn add aws-amplify-react-native
      
    • App.js
      import Amplify from 'aws-amplify';
      import config from './src/aws-exports’;
      
      Amplify.configure(config);
  13. modify amplify framework's API code in expo

  14. execute amplify mock & expo start --android

    • make sure to get connection between amplify's localhost api and expo debugging
  15. amplify add auth

    • add auth via Amplify CLI
      $ amplify add auth
      
      Using service: Cognito, provided by: awscloudformation
      
      The current configured provider is Amazon Cognito. 
      
      Do you want to use the default authentication and security configuration? "Default configuration"
      Warning: you will not be able to edit these selections. 
      How do you want users to be able to sign in? "Username"
      Do you want to configure advanced settings? "No, I am done."
      
      Successfully added resource justappf8f30b2f locally
      
    • add @auth directive in amplify/backend/api/justapp/schema.graphql
      type Post
        @model
        @auth(rules: [{ allow: owner, ownerField: "author", operations: [delete] }]) {
        id: ID!
        content: String!
          @auth(rules: [{ allow: owner, ownerField: "author", operations: [update] }])
        likes: Int!
        author: String!
          @auth(rules: [{ allow: owner, ownerField: "author", operations: [update] }])
        createdAt: String!
        updatedAt: String!
      }
  16. amplify update api

    • Change authorization type API Key -> Amazon Cognito User Pool
    • and updated schema to type Amplify CLI
      $ amplify api update
      ? Please select from one of the below mentioned services: "GraphQL"
      ? Choose the default authorization type for the API "Amazon Cognito User Pool"
      Use a Cognito user pool configured as a part of this project.
      ? Do you want to configure advanced settings for the GraphQL API "No, I am done."
      
  17. amplify mock

    • deploy Auth resource to AWS Cloud
    • check added cognito_user_pool Auth Type in Amplify's API Mock console
    $ amplify mock
    Some resources have changed locally and these resources are not mockable. The resources listed below need to be pushed to the cloud before starting the mock server.
    
    Current Environment: dev
    
    | Category | Resource name   | Operation | Provider plugin   |
    | -------- | --------------- | --------- | ----------------- |
    | Auth     | justappf8f30b2f | Create    | awscloudformation |
    ? Are you sure you want to continue? "Yes"
    
  18. import Amplify's Auth module in expo

    • navigator/stack.js
      • wrap StackNav component with withAuthenticator
          export default withAuthenticator(StackNav);
      • add SignOut event
    • add Auth module at screen/AuthLoadingScreen.js
  19. amplify add storage

    • add storage resource via Amplify's CLI and push storage
      $ admplif add storage
      
      ? Please select from one of the below mentioned services: "Content (Images, audio, video, etc.)"
      ? Please provide a friendly name for your resource that will be used to label this category in the project: "justappstorage"
      ? Please provide bucket name: "justappstorage"
      ? Who should have access: "Auth and guest users"
      ? What kind of access do you want for Authenticated users? "create/update, read, delete"
      ? What kind of access do you want for Guest users? "read"
      ? Do you want to add a Lambda Trigger for your S3 Bucket? "No"
      
      $ amplify push storage
      
    • add type S3Object in schema.graphql
        type S3Object {
          bucket: String!
          region: String!
          key: String!
        }
        type Post
          @model
          @auth(rules: [{ allow: owner, ownerField: "author", operations: [delete] }]) {
          id: ID!
          content: String!
            @auth(rules: [{ allow: owner, ownerField: "author", operations: [update] }])
          image: S3Object!
            @auth(rules: [{ allow: owner, ownerField: "author", operations: [update] }])
          likes: Int!
          author: String!
            @auth(rules: [{ allow: owner, ownerField: "author", operations: [update] }])
          createdAt: String!
          updatedAt: String!
        }
    • update schema via Amplify's CLI
      $ amplify api update
      $ amplify codegen
      
  20. re-configure graphql query maximum statement depth

    • before doing this, check out the cheatsheet/src/graphql/queries.js file and see GraphQL query's statement depth
    • after amplify configure codegen process, check out the GraphQL query's statement depth again.
    $ amplify configure codegen
    
    ? Choose the code generation language target javascript
    ? Enter the file name pattern of graphql queries, mutations and subscriptions src/grap
    hql/**/*.js
    ? Enter maximum statement depth [increase from default if your schema is deeply nested
    ] 3
    
    $ amplify codegen
    ✔ Generated GraphQL operations successfully and saved at src/graphql
    
  21. push amplify's resouces

    $ amplify push
    
  22. modify Amplify's code in expo

    • add checking likes count with Amplify API's subscription query in useEffect in src/screen/Main.js
    • uncomment bucket/region/path of <Post /> in src/screen/Main.js
    • add Amplify's mutation in src/component/Post.js
  23. run expo start --android and

    • sign up & sign in app
    • add post
    • click 'like' button
    • check 'likes' value changes with subscription query
      • modify likes data in AWS AppSync Web Console
  24. amplify add analytics

    • add analytics resouce via Amplify's CLI and push analytics
      $ amplify add analytics
      Scanning for plugins...
      Plugin scan successful
      Using service: Pinpoint, provided by: awscloudformation
      ? Provide your pinpoint resource name: "justapp"
      Adding analytics would add the Auth category to the project if not already added.
      ? Apps need authorization to send analytics events. Do you want to allow guests and un
      authenticated users to send analytics events? (we recommend you allow this when gettin
      g started) "Yes"
      
      $ amplify push analytics
      
    • import Amplify's Analytics module in expo
  25. expo start & check analytics on AWS console

  26. amplify delete

Build Standalone App

Reference

Building Standalone Apps

Step

Android

  • add prop in app.json
      "android": {
        "package": "com.awskrug.justapp"
      }
  • expo build:android -t apk
  • expo fetch:android:keystore and backup your keystore to a safe location

iOS

  • add prop in app.json
      "ios": {
        "bundleIdentifier": "com.awskrug.justapp",
      }
  • expo build:ios
    • You are given a choice of letting the Expo client create the necessary credentials for you, while still having a chance to provide your own overrides. Your Apple ID and password are used locally and never saved on Expo's servers.
    $ expo build:ios
    [16:44:37] Checking if current build exists...
    
    [16:44:37] No currently active or previous builds for this project.
    [16:44:37]
    We need your Apple ID/password to manage certificates, keys
    and provisioning profiles from your Apple Developer account.
    
    Note: Expo does not keep your Apple ID or your Apple ID password.
    
    ? What's your Apple ID? [email protected]
    ? Password? [hidden]
    ✔ Authenticated with Apple Developer Portal successfully!
    [16:44:46] You have 4 teams associated with your account
    ? Which team would you like to use? 3) ABCDEFGHIJ "John Turtle" (Individual)
    ✔ Ensured App ID exists on Apple Developer Portal!
    [16:44:59] We do not have some credentials for you: Apple Distribution Certificate, Apple Push Notifications service key, Apple Provisioning Profile
    ? How would you like to upload your credentials? (Use arrow keys)
    ❯ Expo handles all credentials, you can still provide overrides
      I will provide all the credentials and files needed, Expo does limited validation