Contents
This is a Electron application, built in Node and TypeScript, that delivers a client a REST API to fully interact with AWS's S3 buckets. This is not a web application directly, but it is a web-app packaged into an Electron window, that runs like an executable, using Chromium browser tech.
For help or guidance in downloading and running the application, see the following subsections.
You must have npm (node package manager) and Nodejs installed on your system!
- Setup npm:
npm install npm@latest -g- Clone/Download:
git clone https://github.com/tberey/ts-node-electron-aws-s3-app.git- Install:
npm install && npm update- Start:
npm run start:appThis is a electron application, which means it runs on your system, rather than a browser web app (yes, electron is technically just doing what a web browser does).
As Such, simply install and run this application and the window will load automatically as if running an executable.
| Endpoint | Action/Desc. | Full URI (hosted locally, on some port; e.g.: 3000) | Request Type |
|---|---|---|---|
|
Empty response body, but returns a 200 status. | GET | |
|
Lists all buckets that currently exist. | GET | |
|
Attempt to find the passed bucket name. | GET | |
|
Lists all objects contained within a passed bucket, if the bucket exists. | GET | |
|
Attempt to find passed object, in the passed bucket, if the bucket exists. | GET | |
|
Create a new empty bucket, if one with the same name does not already exist. | POST | |
|
Upload a local file to a specified bucket, if that bucket exists. | POST | |
|
Download a remote file from a specified bucket, if that bucket exists, and the file can be found. | POST | |
|
Delete a passed bucket, if that bucket exists and it is empty. | DELETE | |
|
Empty bucket by deleting all containing objects, if the supplied bucket exists and not already empty. | DELETE |
Logging Sample:
Below is the refined and confirmed roadmap, that has been planned for completion. See open issues and also the project board, for any other proposed features or known issues, which may not be listed below.
| Feature/Task/Bugfix | Details | Version (if released) | Notes |
|---|---|---|---|
| Bug#1 | Bug details... | 0.0.1 | example#1 |
| Feature#4 | Feature details... | example#2 |
| Version | Date | Changes |
|---|---|---|
| 1.0.0 | 2021-07-10 |
|
| 1.0.1 | 2021-07-14 |
|
| 1.0.2 | 2021-08-03 |
|
| 1.0.3 | 2021-08-04 |
|
Contributions are welcomed and, of course, greatly appreciated.
- Fork the Project.
- Create your Feature Branch (
git checkout -b feature/Feature) - Commit your Changes (
git commit -m 'Add some Feature') - Push to the Branch (
git push origin feature/Feature) - Open a Pull Request.
Tom Berey; Project Manager, Lead Developer, Principal Tester & Customer Services;
tomberey1@gmail.com;