amazon-archives/aws-appsync-chat

Chatt

Real-Time Offline Ready Chat App written with GraphQL, AWS AppSync, & AWS Amplify

Features

• User management
• Routing (React Router)
• Real-time
• Offline ready (conflict resolution handled for you when user comes back online)

Technologies

• AWS AppSync
• AWS Amplify
• GraphQL
• MobX
• React Router
• React Apollo
• Glamor

Screens

Building the App (automated)

This project contains an Amplify project (/amplify) already configured & ready to be deployed. Deploying this project will create the following resources in your account: an authentication configuration using Amazon Cognito, an AWS AppSync GraphQL API, & a DynamoDB table.

1. Make sure you are on the newest version of the AWS Amplify CLI

npm install -g @aws-amplify/cli

You must also have the CLI configured with a user from your AWS account (amplify configure). For a walkthrough of how to do this, check out this video.

2. Clone Chatt

git clone https://github.com/aws-samples/aws-appsync-chat.git

3. Install dependencies

npm install

4. Initialize the amplify project

amplify init

• Enter a name for the environment master

5. Push the new resources to the cloud

amplify push

6. Run the project

npm start

7. Deleting the project resources

If you'd like to tear down the project & delete all of the resources created by this project, run the delete command.

amplify delete

Building the App (manually)

You can also manually set up your resources if you would like. If you would like to manually create & configure the resources for this project, follow these steps:

1. Install & configure the Amplify CLI

npm install -g @aws-amplify

amplify configure

2. Clone Chatt

git clone https://github.com/aws-samples/aws-appsync-chat.git

3. Install dependencies

npm install

4. Delete the amplify folder

5. Initialize a new Amplify project

amplify init

6. Add authentication

amplify add auth

Here, either choose the default security choice or configure your own.

7. Add the api

amplify add api

Choose Cognito User Pools as the authentication type. When prompted for the GraphQL schema, use the following schema:

type User 
  @model 
  @auth(rules: [{ allow: owner, ownerField: "id", queries: null }]) {
  id: ID!
  username: String!
  conversations: [ConvoLink] @connection(name: "UserLinks")
  messages: [Message] @connection(name: "UserMessages")
	createdAt: String
	updatedAt: String
}

type Conversation
  @model(
    mutations: { create: "createConvo" }
    queries: { get: "getConvo" }
    subscriptions: null
  )
  @auth(rules: [{ allow: owner, ownerField: "members" }]) {
  id: ID!
  messages: [Message] @connection(name: "ConvoMsgs", sortField: "createdAt")
  associated: [ConvoLink] @connection(name: "AssociatedLinks")
  name: String!
  members: [String!]!
	createdAt: String
	updatedAt: String
}

type Message 
  @model(subscriptions: null, queries: null) 
  @auth(rules: [{ allow: owner, ownerField: "authorId" }]) {
  id: ID!
  author: User @connection(name: "UserMessages", keyField: "authorId")
  authorId: String
  content: String!
  conversation: Conversation! @connection(name: "ConvoMsgs")
  messageConversationId: ID!
	createdAt: String
	updatedAt: String
}

type ConvoLink 
  @model(
    mutations: { create: "createConvoLink", update: "updateConvoLink" }
    queries: null
    subscriptions: null
  ) {
  id: ID!
  user: User! @connection(name: "UserLinks")
  convoLinkUserId: ID
  conversation: Conversation! @connection(name: "AssociatedLinks")
  convoLinkConversationId: ID!
	createdAt: String
	updatedAt: String
}

type Subscription {
  onCreateConvoLink(convoLinkUserId: ID!): ConvoLink
    @aws_subscribe(mutations: ["createConvoLink"])
  onCreateMessage(messageConversationId: ID!): Message
    @aws_subscribe(mutations: ["createMessage"])
}

8. Run the push command to create the resources in your account:

amplify push

9. Run the project

npm start

10. Deleting the project resources

If you'd like to tear down the project & delete all of the resources created by this project, run the delete command.

amplify delete

Hosting with the AWS Amplify Console

The AWS Amplify Console provides continuous deployment and hosting for modern web apps (single page apps and static site generators) with serverless backends. Continuous deployment allows developers to deploy updates to either the frontend or backend (Lambda functions, GraphQL resolvers) on every code commit to the Git repository.

1. Push your code to a Git repository of your choice.
2. Login to the AWS Amplify Console and choose Connect app
3. Connect your repository and branch.
4. Accept the default build settings.
5. Give the Amplify Console permission to deploy backend resources with your frontend. This will allow the Console to detect changes to your backend on every code commit. If you do not have a service role, follow the prompts to create one.
6. Review your changes and then choose Save and deploy. You app will now be available at https://master.unique-id.amplifyapp.com.

About

Schema

This application utilizes 4 database tables:

• User table (stores user's identity information)
• Conversation table (stores conversations)
• Messages table (stores messages)
• ConvoLinkTable (stores relations between conversations & users)

License

This library is licensed under the Apache 2.0 License.