From 1a17fb539b30e90d0f28f5adddb7f2f2ab0c28b5 Mon Sep 17 00:00:00 2001 From: Hamza Hassan Date: Sat, 31 Aug 2024 20:16:11 +0500 Subject: [PATCH] Update README.md --- README.md | 45 +++++---------------------------------------- 1 file changed, 5 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 2f7bf87..f1c4a62 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,11 @@ - - -# Serverless Framework Node Express API on AWS - -This template demonstrates how to develop and deploy a simple Node Express API service running on AWS Lambda using the Serverless Framework. - -This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to the [serverless-http README](https://github.com/dougmoscrop/serverless-http). +# Reporting Service ## Usage ### Deployment +Add config in `.env` similar to `.env.example` + Install dependencies with: ``` @@ -47,30 +32,10 @@ functions: _Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [`httpApi` event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). -### Invocation - -After successful deployment, you can call the created application via HTTP: - -``` -curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/ -``` - -Which should result in the following response: - -```json -{ "message": "Hello from root!" } -``` - ### Local development -The easiest way to develop and test your function is to use the `dev` command: +The easiest way to develop and test your function is to use the `offline` command: ``` -serverless dev +serverless offline ``` - -This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud. - -Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy. - -When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.