Code Monkey home page Code Monkey logo

edocs-documents-api's Introduction

Edocs Documents API

Table of Contents

Overview

The Edocs Documents API consits of 2 services:

  • The /api that handles the connection to edocs api, cashes documents into an S3 bucket and redirects to the document address.
  • /authorizer handles authentication
  • The API is deployed as an AWS lambda via serverless.

Dev Dependencies

  • npm install --save-dev serverless-dynamodb-local
  • npm install -g serverless
  • npm install -g dynamodb-admin
  • npm install jest

Setup

  1. Copy .env.example to .env and fill in the secrets
  2. Run npm install
  3. Run npm start to run the application locally(port 3000)
  4. Run npm test to run all the tests
  5. Run npm run lint to run the linter
  6. Run npm run start-with-auth to run the application with authentication locally

See the package.json for the steps involved in building and running the app.

Usage

Request a document:

  • Route: /documents/{id}
  • Method: GET

edocs-documents-api's People

Contributors

ninamma avatar c-gyorfi avatar bjpirt avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

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.