From b13887ceb8fb1fe67324ecfc71d0cf8da6d22cf6 Mon Sep 17 00:00:00 2001 From: Lily2point0 Date: Wed, 13 Sep 2017 19:37:38 +0100 Subject: [PATCH 1/3] added Readme instructions --- page-uploader/README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/page-uploader/README.md b/page-uploader/README.md index 458e850..066dfe2 100644 --- a/page-uploader/README.md +++ b/page-uploader/README.md @@ -1,5 +1,30 @@ -#Page Uploader -Upload data to S3 pages bucket with this tool +# Page Uploader +## What it is? +This electron application lets you upload archive files to S3 to be processed and digitised. +The use of this tool is restricted to FT Staff and requires authentication. -Based off [Electron Quick Start](https://github.com/electron/electron-quick-start) \ No newline at end of file + +## Things that are restricted +- You need to be authenticated (you can go through the authentication process within the app) +- If your aim is to upload files for the FT Archive, you should be using the compiled application, not run the source +- The files to upload can only be XML or JPG, and need to have a valid name format +- The compiled application is for Mac only at the moment + +## For developers + +### Settings +Before compiling the application, ensure you fill in the relevant information in `keys.js`, regarding the bucket name, bucket region, and authenticator URL. These can be found in the project document (P42). +To run the application without compiling, you need a `.env` file with the same variables. (Run `npm start` after creating your environment variables). + +Add the icons in a `build` folder (these can also be found in the project document). + +Ensure the intended user are white-listed in the authenticator (see P43). + +### How to compile the application +Ensure you create a self-signed certificate ([Intructions from Apple](https://support.apple.com/kb/PH20131)) from your key chain (and set it to always trust). Create a `dist` folder at the root, then run `npm run dist`. The compiled application will appear in the `dist` folder. + +The latest version of the compiled application can be found in the project folder, so ensure you replace it there before distributing it. + + +_Note: This is originally based off [Electron Quick Start](https://github.com/electron/electron-quick-start)_ \ No newline at end of file From 93208664a16e2fd87d8a5c19ea90d7b60bd32e7f Mon Sep 17 00:00:00 2001 From: Lily2point0 Date: Thu, 14 Sep 2017 10:38:31 +0100 Subject: [PATCH 2/3] added link to project doc --- page-uploader/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/page-uploader/README.md b/page-uploader/README.md index 066dfe2..692f3f1 100644 --- a/page-uploader/README.md +++ b/page-uploader/README.md @@ -14,7 +14,7 @@ The use of this tool is restricted to FT Staff and requires authentication. ## For developers ### Settings -Before compiling the application, ensure you fill in the relevant information in `keys.js`, regarding the bucket name, bucket region, and authenticator URL. These can be found in the project document (P42). +Before compiling the application, ensure you fill in the relevant information in `keys.js`, regarding the bucket name, bucket region, and authenticator URL. These can be found in the [project document](https://drive.google.com/drive/folders/0ByuKzl5VTNFgaHBrS3R1a0NUSEU) (P42). To run the application without compiling, you need a `.env` file with the same variables. (Run `npm start` after creating your environment variables). Add the icons in a `build` folder (these can also be found in the project document). From 89c6040e366744a53e49b15ac723cf783c4533e9 Mon Sep 17 00:00:00 2001 From: Lily2point0 Date: Thu, 14 Sep 2017 10:40:26 +0100 Subject: [PATCH 3/3] added speak to Labs cta --- page-uploader/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/page-uploader/README.md b/page-uploader/README.md index 692f3f1..f941c12 100644 --- a/page-uploader/README.md +++ b/page-uploader/README.md @@ -7,7 +7,7 @@ The use of this tool is restricted to FT Staff and requires authentication. ## Things that are restricted - You need to be authenticated (you can go through the authentication process within the app) -- If your aim is to upload files for the FT Archive, you should be using the compiled application, not run the source +- If your aim is to upload files for the FT Archive, you should be using the compiled application, not run the source (speak to Labs to get the application and the files) - The files to upload can only be XML or JPG, and need to have a valid name format - The compiled application is for Mac only at the moment