Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrew-cunliffe/serverless-typescript-quickstart

Quickstart project for creating a Node project using Serverless and Typescript with Cucumber for testing
https://github.com/andrew-cunliffe/serverless-typescript-quickstart

Last synced: 3 months ago
JSON representation

Quickstart project for creating a Node project using Serverless and Typescript with Cucumber for testing

Awesome Lists containing this project

README

        

## Serverless Typescript Quickstart

This is a quickstart example for build an API using Serverless and Typescript

[![CircleCI](https://circleci.com/gh/andrew-cunliffe/serverless-typescript-quickstart.svg?style=svg)](https://circleci.com/gh/andrew-cunliffe/serverless-typescript-quickstart)

Underlying technologies and frameworks - Node, Serverless, Express, Typescript, Cucumber

### Requirements

- Node 8

### Available commands

- npm install
Installs required dependencies, must always be run before any other commands will work

- npm run test
This uses express directly to execute the functional tests

- npm start
Runs serverless offline locally to allow for development of UI

- npm deploy:test
Performs a deployment to the test environment

### Deployment

This is performed via Circle CI and uses the scripts `npm run test` and `npm run deploy:prod` to perform required checks and deployments