Skip to content
This repository has been archived by the owner on Feb 15, 2020. It is now read-only.
/ coding-101-2019 Public archive

API and Node Module used for the DEVS Coding 101 Workshop

Notifications You must be signed in to change notification settings

devsuoa/coding-101-2019

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

coding-101

Library used for the DEVS coding 101 workshop. The library consists of two parts. The api directory contains a REST API used to interact with AWS services such as Comprehend. The client directory contains a node module which acts as an SDK for the API.

JavaScript Resources

Interested in learning more JavaScript? Take a look at the following links:


API

The API is hosted on AWS using the AWS Serverless Application Model (SAM) which is a superset of CloudFormation. The API uses make to handle build and deployment steps.

Documentation

API documenation is written using swagger (Open Api). View the raw specification api/swagger.yaml or use the swagger-ui for a more readable format on localhost:80

docker-compose up

Dependencies

To build/run/deploy the API, the awscli and aws-sam-cli must first be installled. Note that python 2.7, 3.6 or 3.7 must be installed as well as Docker.

pip install --user --upgrade awscli
pip install --user --upgrade aws-sam-cli

Local Testing

The API can be tested locally at localhost:3000.

make local

Deployment

The API can be deployed as follows.

make package deploy

Undeployment

Similarly, the API can be undeployed.

make undeploy

Module

The Node Module is published using npm.

About

API and Node Module used for the DEVS Coding 101 Workshop

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published