Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charlespalmerbf/aws-s3-client
A local AWS S3 node client with AWS Lambda examples.
https://github.com/charlespalmerbf/aws-s3-client
aws aws-api-gateway aws-lambda aws-s3 client-server expressjs nodejs
Last synced: about 2 months ago
JSON representation
A local AWS S3 node client with AWS Lambda examples.
- Host: GitHub
- URL: https://github.com/charlespalmerbf/aws-s3-client
- Owner: charlespalmerbf
- License: mit
- Created: 2024-04-03T16:13:06.000Z (10 months ago)
- Default Branch: develop
- Last Pushed: 2024-04-07T22:48:56.000Z (10 months ago)
- Last Synced: 2024-04-07T23:31:30.688Z (10 months ago)
- Topics: aws, aws-api-gateway, aws-lambda, aws-s3, client-server, expressjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS S3 Client
This is a simple node application that allows you to upload, download, and view files in an AWS S3 bucket. It uses the AWS SDK for JavaScript to interact with S3 and supports pulling credentials from a `.env` file.
## Prerequisites
Before running this application, make sure you have the following:
- Node.js and npm installed on your system
- AWS account with access to an S3 bucket
- AWS Access Key ID and Secret Access Key with permissions to read from and write to the S3 bucket
- Environment variables set up in a `.env` file with the following keys:
```
AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_REGION=your-region
AWS_BUCKET_NAME=your-bucket-name PORT=3000
```
## Installation
1\. Clone this repository to your local machine:
```bash
git clone https://github.com/charlespalmerbf/aws-s3-client.git
```
1. Navigate to the project directory:
`cd aws-s3-client`
2. Install dependencies:
`npm install`
Usage
-----
1. Start the server:
`node app.js`
2. The server will start running on port 3000 by default. You can change the port by modifying the `PORT` variable in the `.env` file.
3. Use the following endpoints to interact with the S3 bucket:
- `/upload`: Upload a file to the S3 bucket using a `POST` request with `multipart/form-data` content type. Use the field name `file` to upload the file.
- `/download/:key`: Download a file from the S3 bucket. Replace `:key` with the key of the file you want to download.
- `/files`: List all files in the S3 bucket.
## Conventional Commits
This project uses a specification called **Conventional Commits**, please **ensure** this specification is followed when commiting code to this project.
Guide: https://www.conventionalcommits.org/en/v1.0.0/
## Pull Requests, Approvals & Releases
###### Creating the develop release pull request
Pull Requests made to this project are required in order to merge to **develop** or **main**
When submitting a Pull Request, at least one approval is required before merging.
When constructing a release, ensure that a release branch is created based off of the contents of develop, the only changes contained within this branch should be the version numbers in **package.json** and android's **build.gradle**.
The Pull Request should be named as **[develop] release vX.Y.Z**
###### Creating the main release pull request
Once this Pull Request has been created, you will need to generate a new Pull Request based off **main** comparing the **develop** release branch you have just created, this should ensure that all changes that have been made to **develop** since the last release are contained within this update.
The Pull Request should be named as **[main] release vX.Y.Z**
###### Creating the release tag
Once this has been done and both Pull Requests have been merged, a release tag should be generated, named as **vX.Y.Z**