# lexicon-rest-api

> Created using the starter project template, built using Serverless and TypeScript.

Latest version **1.0.2** (published 2018-04-20) · 0 weekly downloads

## Install

```sh
npm install lexicon-rest-api
pnpm add lexicon-rest-api
yarn add lexicon-rest-api
bun add lexicon-rest-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-04-20 |
| First published | 2018-04-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 195.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | benwurth |

## Links

- npm: https://www.npmjs.com/package/lexicon-rest-api
- npm.io page: https://npm.io/package/lexicon-rest-api

## Dependencies (7)

- [pg](https://npm.io/package/pg.md) ^7.4.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.140.0
- [typeorm](https://npm.io/package/typeorm.md) ^0.1.16
- [sqs-producer](https://npm.io/package/sqs-producer.md) ^1.6.1
- [@types/sqs-producer](https://npm.io/package/@types/sqs-producer.md) ^1.5.4
- [@benwurth/lexicon-data](https://npm.io/package/@benwurth/lexicon-data.md) ^0.0.14
- [@benwurth/lexicon-custom-video-common](https://npm.io/package/@benwurth/lexicon-custom-video-common.md) ^1.0.11

## Recent versions

- 1.0.2 (latest) — 2018-04-20
- 1.0.1 — 2018-04-14

## README

# aws-nodejs-typescript

This repository contains a starter project template for Serverless projects running on AWS.

Built with Serverless and TypeScript.

This is a custom version of the default `aws-nodejs-typescript` template in the Serverless 
[repository](https://github.com/serverless/serverless/tree/34dd46440ebd1a5aeeea229b8cb20c3fce730d6d/lib/plugins/create/templates/aws-nodejs-typescript).

Here are the notable differences:
- comes with `@types/aws-lambda` for typed Lambda handler function definition
- more verbose TypeScript configuration in `tsconfig.json`
- no Webpack dependency or configuration needed; instead uses `serverless-plugin-typescript`
- comes with the `serverless-offline` plugin for local development

## Usage

### Setup

Here are the steps to create a new project based on this template.

1. Install serverless globally.

    ```bash
    npm install -g serverless
    ```

2. Create a new project based on this template, specifying the name for your new project.

    ```bash
    serverless install --url https://github.com/echelon-solutions/aws-nodejs-typescript --name <my-new-project>
    ```

3. Install the project dependencies.

    ```bash
    cd <my-new-project>
    npm install
    ```

### Develop

Run a mocked local environment with hot-reload ...

```bash
npm run dev
```

This will start a mock API Gateway serving the Lambda functions you've defined.

Call the API at `http://localhost:3000`.

### Deploy

Deploy the project to the cloud ...

```bash
npm run deploy
```

## Further Reading

Browse the following resources for more information:

- Serverless [documentation](https://serverless.com/framework/docs/)
- TypeScript [documentation](https://www.typescriptlang.org/docs/)
- AWS [documentation](https://aws.amazon.com/documentation/)

---
_Source: https://npm.io/package/lexicon-rest-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._