Giter Club home page Giter Club logo

aws_file_upload_service's Introduction

๐Ÿ“ AWS File Upload Service

๐Ÿš€ Overview

This is a robust and scalable File Upload Service built with โ˜๏ธ AWS Lambda and S3. It allows users to effortlessly upload, download, and delete files from the cloud storage - all with a secure and user-friendly interface.

๐ŸŒŸ Features

  • ๐Ÿ” User registration and authentication
  • ๐Ÿ“ค File upload
  • ๐Ÿ“ฅ File download
  • ๐Ÿ—‘๏ธ File deletion

Tech Stack ๐Ÿ› ๏ธ

Our service leverages a variety of powerful technologies:

  • ๐Ÿ Python
  • โ˜๏ธ AWS Lambda
  • โ˜๏ธ AWS S3
  • โš™๏ธ AWS SAM for local development and deployment
  • โš™๏ธ Github Actions

๐Ÿ— Project Structure

/project_root
    /lambda_functions
        /auth
            lambda_function.py
        /upload
            lambda_function.py
        /download
            lambda_function.py
        /delete
            lambda_function.py
    /tests
        test_functions.py
    template.yaml
    requirements.txt
    .github/workflows/main.yml

โš™๏ธ Installation and Setup

  1. Clone the repository
git clone <repository-url>
  1. Navigate to the project directory
cd <project-dir>
  1. Install the Requirements
pip install -r requirements.txt
  1. Install AWS SAM CLI Follow the instructions here to install the AWS SAM CLI.

  2. Install Docker Follow the instructions here to install Docker as it is required to run AWS Lambda functions locally.

Running Locally with SAM

After setting up, navigate to your project root directory in the terminal and use the SAM CLI to invoke the functions locally.

Start the API Gateway locally

sam local start-api
  • After starting the local API Gateway, you can send HTTP requests to the locally running API, for example, using curl or Postman.

๐Ÿงช Running Tests

Navigate to your project root directory and run:

pytest tests/

๐ŸŒ Deploying

Deployment is handled via GitHub Actions which use AWS SAM to build, package, and deploy the application.

Make sure to setup GitHub Secrets in your repository to store AWS Access Key ID, AWS Secret Access Key, and any other sensitive information securely.

Note:

Please store sensitive data like JWT Secret Keys in AWS Secrets Manager for production. When testing locally with SAM and Docker, ensure Docker is running. It is recommended to understand the AWS Free Tier limitations to avoid incurring additional costs.

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.