ngx-s3-upload - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #golang #android #machine-learning #deep-learning #cli #awesome-list #pytorch #mcp #ios #openai

ngx-s3-upload

(★ 94)

Angular 6: S3 uploads using Cognito authentication

File Explorer

Download Latest Version (.zip)

- - app-routes.module.ts
  - app.component.css
  - app.component.html
  - app.component.spec.ts
  - app.component.ts
  - app.module.ts
- - .gitkeep
- - cognito.ts
  - index.ts
  - s3.ts
- - environment.prod.ts
  - environment.ts
- - Dictionary.ts
  - index.ts
- - file-size.pipe.ts
  - file-size.ts
  - index.ts
  - month.ts
  - s3.ts
  - url.ts
- favicon.ico
- index.html
- main.ts
- polyfills.ts
- styles.css
- styles.scss
- test.ts
- tsconfig.app.json
- tsconfig.spec.json
- typings.d.ts
.angular-cli.json
.editorconfig
.gitignore
.npmignore
angular.json
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tslint.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73QY55FZWSPRJ)

# Get started
This is a fully functional Angular 6 App to upload to S3 directly from browser using Cognito user and identity pools. For architecture and background details go [here](https://medium.com/tensult/s3-direct-upload-with-cognito-authentication-56a5c0ff4916).

## Software Installation
* [Git](https://git-scm.com/downloads)
* [NodeJS](https://nodejs.org/en/download/)

# Configure with your own AWS account
## Amazon S3 Setup
* Create Bucket for upload your objects.
   * Note: S3 bucket name should be globally unique.
* Enable CORS on S3 bucket with following CORS permissions.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
    <AllowedOrigin>*</AllowedOrigin>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <AllowedMethod>POST</AllowedMethod>
    <AllowedMethod>DELETE</AllowedMethod>
    <MaxAgeSeconds>3000</MaxAgeSeconds>
    <ExposeHeader>ETag</ExposeHeader>
    <AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>
```
![s3corspolicy](https://user-images.githubusercontent.com/33080863/42218959-e0a7a64e-7ee7-11e8-8535-a66d785e7193.png)
* Video instructions are available at https://www.screencast.com/t/SWEq2r1Kx
## Amazon Cognito Setup
* Create cognito user pool. 
  * Video instructions are available at https://www.screencast.com/t/Njwyv1v6Se9
* Create cognito identity pool and associate with user pool.
   Note : Associate role for authenticated users with cognito identity pool with PutObject permission to the S3 buckets. You can also refer to the my identity pool [policy](https://gist.github.com/koladilip/3b70c313a7071d12a83b818efa1abc75/).
  * Video instructions are available at https://www.screencast.com/t/Mrd4zbvCLN
  
## Workspace setup
```
git clone https://github.com/tensult/ngx-s3-upload.git
cd ngx-s3-upload
```
## Configurations
 * Update the bucket details and your s3 bucket default region:[src/config/s3.ts](https://github.com/tensult/ngx-s3-upload/blob/master/src/config/s3.ts) accordingly.
 * Update google analytics code: [src/index.html](https://github.com/tensult/ngx-s3-upload/blob/master/src/index.html) accordingly.
 * Update [src/config/cognito.ts](https://github.com/tensult/ngx-s3-upload/blob/master/src/config/cognito.ts) accordingly.
 * Video instruction are available at https://www.screencast.com/t/MfzWbYHkvSsR
## Starting the App
```
npm install
npm start
```
Once app is successfully started: open http://localhost:4200/ in your browser
* Go to http://localhost:4200
* Video instructions are available at https://www.screencast.com/t/ncqBeM2mW7D

## S3 website Bucket setup for hosting the web app

## Create a user in Cognito User Pools
 Video instructions are available at :https://www.screencast.com/t/ye42zx51

# Sample Screens
## Home page
* When you start application, first this page will be opened.
![home](https://user-images.githubusercontent.com/30007458/38555020-4ccdb3ec-3ce2-11e8-966d-431680d6cd5b.png)

## Signin page
* You have to do signin first for accessing *upload* feature.
![signin](https://user-images.githubusercontent.com/30007458/38555175-d204ee86-3ce2-11e8-9383-7ca1d570a06c.png)

## Upload page
* After signin this page will be opened. 
* You can add one file or multiple files by clicking on `add files` button.
![upload](https://user-images.githubusercontent.com/30007458/38555258-243eae76-3ce3-11e8-86c5-fe79fabbfb2a.png)
* After adding one file or multiple files, you can upload those files by clicking on `upload all` button or individually by clicking on `upload` button. 
* Also you can clear and cancel.
![upload-1](https://user-images.githubusercontent.com/30007458/38555284-35fd3f06-3ce3-11e8-9f71-aeb034e83afe.png)
* You can signout by clicking on `signout` link.
![signout](https://user-images.githubusercontent.com/30007458/38556442-54068062-3ce7-11e8-9dee-33d32a92fe12.png)

## Uploaded files page
* After clicking on `Downloads` link from upload page, this page will be opened. 
* Here you can see those files you uploaded.
![downloads](https://user-images.githubusercontent.com/30007458/38556505-8c08bc5a-3ce7-11e8-8ddd-d83c28de6680.png)
* Video instructions are available at https://www.screencast.com/t/JuauJmxQf

## Hosting a Static Website on Amazon S3
* Create a new bucket on Amazon S3 for static website hosting.
* Update bucket policy on s3 bucket with the following policy

```
{
    "Version": "2008-10-17",
    "Statement": [
        {
            "Sid": "Allow Public Access to All Objects",
            "Effect": "Allow",
            "Principal": "*",
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::s3-website-hosting/*"
        }
    ]
}
```

## Build your App
  npm run build

* Upload the build files on S3 bucket.
* In static website hosting choose "Use this bucket to host a website" option and 
put index.html in Index document option. 
* Click the endpoint url generated on s3 bucket.
* Video instructions are available at: https://www.screencast.com/t/IaQm07kq6

**Note:**
We are uploading files at a folder named by your email in S3 bucket.