-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |