giannativo / suggestion_engine_serverless

Suggestion Engine

The goal of this application is to provide grammar suggestions for a sentence, paragraph or a full text document. The application consists of an endpoint which will send the suggestions based on the text received.

Usage

Request:

POST http://localhost:3000/
content-type: application/json
{
  "text": "The car was repaired carefully by the skilled mechanic."
}

Response:

{
  "matches": [
    {
      "message": "\"carefully\" can weaken meaning",
      "shortMessage": "Adverb found.",
      "offset": 21,
      "length": 9,
      "sentence": "The car was repaired carefully by the skilled mechanic.",
      "rule": {
        "id": "ADVERB",
        "description": "An adverb is found."
      }
    },
    {
      "message": "\"was repaired\" may be passive voice",
      "shortMessage": "Passive voice found.",
      "offset": 8,
      "length": 12,
      "sentence": "The car was repaired carefully by the skilled mechanic.",
      "rule": {
        "id": "PASSIVE_VOICE",
        "description": "Use of passive voice was found."
      }
    }
  ],
  "stats": {
    "score": 7.78,
    "rules": [
      {
        "id": "ADVERB",
        "count": 1
      },
      {
        "id": "PASSIVE_VOICE",
        "count": 1
      },
      {
        "id": "COMPLEX_SENTENCE",
        "count": 0
      }
    ]
  }
}

Basic Starter for NestJS on AWS Lambda with Serverless

We use Serverless Framework to do production ready deployments and local development using serverless-offline.

Usage

To install this example to bootstrap your project, run the following command:

npx serverless install -u https://github.com/nanlabs/devops-reference/tree/main/examples/serverless-node-typescript-nest -n my-project

Requirements

You’ll need to have Node 16.13.2 or later on your local development machine (but it’s not required on the server). You can use fnm to easily switch Node versions between different projects.

git clone https://github.com/nanlabs/devops-reference.git
cd devops-reference/examples/serverless-node-typescript-nest
fnm use
npm install

Local Development

This repo has a local development set up that uses the file .env.local to configure the local environment. Run the following command to start the local development server:

npm run sls:offline

It will start the following services:

• AWS Lambda at http://localhost:3000

Lambda Deployment

To deploy the app to AWS, you'll first need to configure your AWS credentials. There are many ways to set your credentials, for more information refer to the AWS documentation.

Once set you can deploy your app using the serverless framework with:

npm run sls:deploy