Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dabit3/react-amplify-appsync-files-s3
An example project showing how to upload and download public and private images in GraphQL using AppSync and S3
https://github.com/dabit3/react-amplify-appsync-files-s3
amplify appsync graphql react serverless
Last synced: 4 days ago
JSON representation
An example project showing how to upload and download public and private images in GraphQL using AppSync and S3
- Host: GitHub
- URL: https://github.com/dabit3/react-amplify-appsync-files-s3
- Owner: dabit3
- Created: 2019-06-27T15:19:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-16T02:08:58.000Z (over 3 years ago)
- Last Synced: 2024-11-04T19:42:08.444Z (9 days ago)
- Topics: amplify, appsync, graphql, react, serverless
- Language: JavaScript
- Homepage:
- Size: 1.17 MB
- Stars: 70
- Watchers: 2
- Forks: 57
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## File uploads and downloads with React, AWS Amplify, AWS AppSync, and Amazon S3
This is an example project showing how to upload and download files and images using AWS Amplify, AWS AppSync, and Amazon S3
This project goes along with the [GraphQL Tutorial - How to Manage Image & File Uploads & Downloads with AWS AppSync & AWS Amplify](https://dev.to/dabit3/graphql-tutorial-how-to-manage-image-file-uploads-downloads-with-aws-appsync-aws-amplify-hga) on [Dev.to](https://dev.to/).
### The question
How do I upload images and files using GraphQL with AWS AppSync?
### The solution
There are a few parts to this solution:
* You must first upload the image to a storage solution (in this example, Amazon S3)
* After you have finished uploading the image, you will need to store a reference to this image in a database using a GraphQL mutation.
* When you want to view a public image (public bucket), you need to:
* Query the image URL from your database using GraphQL
* When you want to view a private image (non-public bucket), you need to do two things:
* First, query the image reference from your database using GraphQL
* Get a signed URL for the image from S3
In this example, I show how to:
1. Store images using GraphQL, AppSync, and S3 (both using public and private access)
2. Fetch a list of images and render them in a React application
2. Fetch a single image and render it in a React application
## To deploy this app
### Amplify CLI
1. Clone the project and change into the directory
```sh
git clone https://github.com/dabit3/react-amplify-appsync-files-s3.git
cd react-amplify-appsync-s3
```
2. Install the dependencies
```sh
npm install
# or
yarn
```
3. Initialize and deploy the amplify project
```sh
amplify init
amplify push
```
4. Run the app
```sh
npm start
```
5. Change the bucket policy [in your S3 bucket](https://s3.console.aws.amazon.com/s3/home) for files in the `images` folder to be public (in order for the Product images to be publicly viewable):
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::/public/images/*"
}
]
}
```
6. Render either the private (Users) or public (Products) example in __src/App.js__:
```javascript
import React from 'react'
import Products from './Products'
import Users from './Users'
function App() {
return (
// or
)
}
export default App;
```
### Amplify Console
Click the button to deploy this application to the Amplify console.
[](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/dabit3/react-amplify-appsync-files-s3)
Then change the bucket policy [in your S3 bucket](https://s3.console.aws.amazon.com/s3/home) for files in the `images` folder to be public (in order for the Product images to be publicly viewable):
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::/public/images/*"
}
]
}
```