master_ontology_app

Application for managing master ontology

Architecture Diagram

Authorization Workflow

Backend

The backend of the project is built based on the aws-nodejs-typescript template from the Serverless framework.

Installation/deployment instructions

Depending on your preferred package manager, follow the instructions below to deploy your project.

Requirements: NodeJS lts/fermium (v.14.15.0). If you're using nvm, run nvm use to ensure you're using the same Node version in local and in your lambda's runtime.

Using NPM

Run npm i to install the project dependencies
Run npx sls deploy to deploy this stack to AWS

Using Yarn

Run yarn to install the project dependencies
Run yarn sls deploy to deploy this stack to AWS

Project structure

The code base for backend is mainly located within the backend/src folder. This folder is divided in:

backend
├── src
│   ├── lambda               # Lambda configuration and source code folder
│   │   ├── auth
│   │   │   ├── userPoolAuthorizer.ts      # lambda function handling API Gateway authorization
│   │   ├── dynamoDb
│   │   │   ├── elasticSearchSync.ts      # lambda function to sync elasticsearch with DynamoDB
│   │   ├── elasticSearch
│   │   │   ├── query.ts      # lambda function to perform full text search against elasticsearch engine
│   │   ├── http
│   │   │   ├── createOntology.ts      # lambda function to add a new ontology into DynamoDB
│   │   │   ├── deleteOntology.ts      # lambda function to delete an ontology from DynamoDB
│   │   │   ├── getOntologies.ts      # lambda function to scan all ontologies from DynamoDB
│   │   │   ├── getOntology.ts      # lambda function to retrieve a single ontology from DynamoDB
│   │   │   ├── updateOntology.ts      # lambda function to update an ontology entry from DynamoDB
│   │
├── package.json
├── serverless.ts               # Serverless service file
├── tsconfig.json               # Typescript compiler configuration
├── tsconfig.paths.json         # Typescript paths
└── webpack.config.js           # Webpack configuration

Frontend

The frontend of the project is built with React.js.

Available Scripts

In the client directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Deployment Instructions

In client directory, run amplify publish to deploy

kevinxin90 / master_ontology_app Goto Github PK