Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hhassan01 authored Oct 23, 2024
1 parent 902b13b commit 14788f2
Showing 1 changed file with 3 additions and 38 deletions.
41 changes: 3 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,6 @@
# Reporting Service

## Usage
## Setup and Usage

### Deployment

Add config in `.env` similar to `.env.example`

Install dependencies with:

```
npm install
```

and then deploy with:

```
serverless deploy
```

After running deploy, you should see output similar to:

```
Deploying "aws-node-express-api" to stage "dev" (us-east-1)
✔ Service deployed to stack aws-node-express-api-dev (96s)
endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
functions:
api: aws-node-express-api-dev-api (2.3 kB)
```

_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/).

### Local development

The easiest way to develop and test your function is to use the `offline` command:

```
serverless offline
```
> Refer to this document for detailed instructions
> https://github.com/EventLedger/.github

0 comments on commit 14788f2

Please sign in to comment.