Skip to content

Commit

Permalink
Readme updates (#1)
Browse files Browse the repository at this point in the history
* minor updates to NOTICE and readme

* simplifying notice after rereading the details and adding a section for running tests in contributing.

* fixed test section

* adding bug-report.md and draft of npmignore

* adding issue templates; fixing labels in README issue links

* deleting .npmignore- not needed for files directive in package.json
  • Loading branch information
jenirain authored Jun 25, 2021
1 parent 17e300d commit 43e93ac
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 7 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug Report
about: Report a bug encountered while using cognito-at-edge
labels: kind/bug
---

<!-- Please use this template while reporting a bug and provide as much info as possible. Not providing sufficient detail could result in your bug not being addressed in a timely manner. Thanks!
-->

#### What happened:

#### What did you expect to have happen:

#### How to reproduce this (as precisely and succinctly as possible):

#### Anything else you think we should know?

#### Environment:
- version of cognito-at-edge being used:
- node version of code base which uses cognito-at-edge:
- other:

-
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Enhancement Tracking Issue
about: Provide supporting details for a feature in development
labels: kind/feature
---

#### What would you like to be added:

#### Why is this needed:
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "⁉️ Need help with cognito-at-edge?"
about: Please file an issue in our help repo.

---

#### How can we help?
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ GitHub provides additional document on [forking a repository](https://help.githu
## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

## Testing the code
Tests are written using jest. To run tests invoke
```
npm test
```


## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
Expand Down
3 changes: 2 additions & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
cognito-at-edge
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
*Serverless authentication solution to protect your website or Amplify application.*

![Architecture](./doc/architecture.png)
This NodeJS library authenticate CloudFront requests with Lambda@Edge based and a Cognito UserPool.

This NodeJS library authenticates CloudFront requests with Lambda@Edge based on a Cognito UserPool.

### Requirements
* NodeJS v10+ (install with [NVM](https://github.com/nvm-sh/nvm))
Expand All @@ -15,7 +16,7 @@ Install the `cognito-at-edge` package:
npm install --save cognito-at-edge
```

Create the a Lambda@Edge function with the following content and modify the parameters based on your configuration:
Create a Lambda@Edge function with the following content and modify the parameters based on your configuration:
```
const { Authenticator } = require('cognito-at-edge');
Expand All @@ -34,7 +35,7 @@ exports.handler = async (request) => authenticator.handle(request);

### Getting started

Based on your requirements you can use of the solution below. They all provide the complete infrastructure leveraging `cognito-at-edge` to protect a website or an Amplify application.
Based on your requirements you can use one of the solutions below. They all provide the complete infrastructure leveraging `cognito-at-edge` to protect a website or an Amplify application.

*WIP*

Expand Down Expand Up @@ -62,8 +63,12 @@ const authenticator = new Authenticator( ... );
exports.handler = async (request) => authenticator.handle(request);
```

### Contact
Please fill an issue in the Github repository ([Open issues](https://github.com/awslabs/cognito-at-edge/issues)).
### Getting Help
The best way to interact with our team is through GitHub. You can [open an issue](https://github.com/awslabs/cognito-at-edge/issues/new/choose)
and choose from one of our templates for [bug reports](https://github.com/awslabs/cognito-at-edge/issues/new?assignees=&labels=bug%2C+needs-triage&template=---bug-report.md&title=),
[feature requests](https://github.com/awslabs/cognito-at-edge/issues/new?assignees=&labels=feature-request&template=---feature-request.md&title=) or
[question](https://github.com/awslabs/cognito-at-edge/issues/new?assignees=&labels=question%2C+needs-triage&template=---questions---help.md&title=).

## License
This project is licensed under the Apache-2.0 License.
This project is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), see
LICENSE.txt and NOTICE.txt for more information.

0 comments on commit 43e93ac

Please sign in to comment.