Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 3.41 KB

_details.md

File metadata and controls

101 lines (76 loc) · 3.41 KB
Raw
layout title nav_order description permalink
default
Details (optional)
3
Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages.
/customization/

Details (optional)

Overview

S3 Directory Stucture

PaperTool requires two primary S3 buckets (folders):

Site bucket

{: .fs-5 .text-purple-000}

It contains the main PaperTool site files (HTML, JS and CSS) and is used for hosting the working paper series portal (specific to each lab/department).

Note: Please assign the name of this bucket as per your lab/department name. E.g. If you set the bucket name as econdept, it will create a site under http://econdept.s3-website-ap-southeast-2.amazonaws.com/.

The folder structure for the site bucket is as follows:

.
├── metadata.json
├── index.html
├── assets
│   ├── css
│   ├── img
│   ├── js

The main site is hosted completely free of cost.

Working papers repository

{: .fs-5 .text-purple-000}

It contains the uploaded papers (as PDF) and their respective metadata (RDF or REDIF files). This is the core repository that will point to RePEc for automated archival of papers on their end.

sodalabs.io: Code for the SoDa WP series website. The file sodalabs.io/metadata.json contains all the working paper meta-data. soda-wps: Code for simulating directory listing on S3 as per RePEc's documentation. uploadWorkingPaper: AWS Lambda function which performs all the post-processing and serves as the backend. Contains all project dependencies. wkhtmltopdf: AWS Lambda layer for binaries required by the PyPDF2 package. PyPDF2 is used by uploadWorkingPaper for HTML to PDF conversion. api-gateway.md: Documentation for configuring an AWS API Gateway endpoint

References RePEc step-by-step tutorial

..

Lambda function

At the heart of the working paper site is the ability to do postprocessing on the uploaded paper and store in within the working papers repository. We use AWS Lambda function uploadWorkingPaper to accomplish the same. Lambda functions are relatively inexpensive and are used only a need-by-need basis when a user uses the site.

Simply upload the uploadWorkingPaper function in your personal/lab AWS Lambda interface. Additionally, the user might need to give necessary persmissions:

  • PUT/GET request on S3

..

API Gateway

Set up an API endpoint to route the data from the website to uploadWorkingPaper lambda function. The endpoint should be provided to <site-bucket>/assets/js/wps.js.

  1. Create a new endpoint: /upload
  2. Select Method: POST
  3. Make sure to enable CORS
  4. Select POST and under Integration Request:
  5. Select Lambda Function as the Integration Type
  6. Configure the following in Mapping template:
Content-Type: application/json
Template:
{
    "content": {
        #foreach( $token in $input.path('$').split('&') )
            #set( $keyVal = $token.split('=') )
            #set( $keyValSize = $keyVal.size() )
            #if( $keyValSize >= 1 )
                #set( $key = $util.urlDecode($keyVal[0]) )
                #if( $keyValSize >= 2 )
                    #set( $val = $util.urlDecode($keyVal[1]) )
                #else
                    #set( $val = '' )
                #end
                "$key": "$val"#if($foreach.hasNext),#end
            #end
        #end
    }
}

Dependencies

  • wkhtmltopdf