Code Monkey home page Code Monkey logo

19-deployment's Introduction

CF 18: Image Uploads w/ AWS S3

Submission Instructions

  • fork this repository & create a new branch for your work
  • write all of your code in a directory named lab- + <your name> e.g. lab-susan
  • push to your repository
  • submit a pull request to this repository
  • submit a link to your PR in canvas
  • write a question and observation on canvas

Learning Objectives

  • students will be able to upload static assets to AWS S3
  • students will be able to retrieve a cdn url that contains the previously uploaded static asset
  • students will be able to work with secret and public access keys

Requirements

Configuration

  • package.json
  • .eslintrc.json
  • .eslintignore
  • .gitignore
  • README.md

Description

  • create an AWS account
  • create an AWS Access Key and Secret
    • add the Access Key and Secret to your .env file
    • DO NOT SHARE THESE KEYS, AND DO NOT COMMIT THEM
  • create a new model that represents a file type that you want to store on AWS S3
    • ex: .mp3, .mp4, .png, etc
  • create a test that uploads one of these files to your route
  • use the aws-sdk to assist with uploading
  • use multer to parse the file upload request

Server Endpoint

  • POST - /api/new-resource
    • your new resource will have a reference to the primary resource that we already have functional
    • that resource will need to be passed via the req.body
  • GET - /api/new-resource/:_id
  • PUT - /api/new-resource/:_id
  • DELETE - /api/new-resource/:_id

Tests

  • create a test to ensure that your API returns a status code of 404 for routes that have not been registered
  • create a series of tests to ensure that your /api/resource-name endpoint responds as described for each condition below:
  • GET - test 200, for a request made with a valid id
  • GET - test 401, if no token was provided
  • GET - test 404, for a valid request with an id that was not found
  • PUT - test 200, for a post request with a valid body
  • PUT - test 401, if no token was provided
  • PUT - test 400, if the body was invalid
  • PUT - test 404, for a valid request made with an id that was not found
  • POST - test 200, for a post request with a valid body
  • POST - test 401, if no token was provided
  • POST - test 400, if no body was provided or if the body was invalid

Bonus: 3pts

  • try using the deleteObject method provided by the aws-sdk to delete an object (file) from S3
    • you will need to pass in a params object that contains the associated Bucket and AWS object key in order to delete the object from s3
    • ex:
    var params = {
      Bucket: 's3-bucket-name',
      Key: 'object-filename'
    }
    s3.deleteObject(params)
  • don't forget to remove the resource from the DB

19-deployment's People

Contributors

saidmattar avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.