@mitchallen/react-cognito-signup
CognitoSignup React component
UNDER CONSTRUCTION
DO NOT USE
Installation
$ npm init
$ npm install @mitchallen/react-cognito-signup --save
Usage
1: Add this line near the top of your file (like src/App.js
):
import CognitoSignup from '@mitchallen/react-cognito-signup';
NOTE: CognitoSignup must be Capitalized or component won't render.
2: Somewhere in the middle of the render method add this line:
<CognitoSignup />
Testing
Run the Tests
To test, go to the root folder and type (sans $):
$ npm test
Component Testing
Prerequisite
If you've never installed create-react-app (you may need to use sudo
):
$ npm install -g create-react-app
Create a local npm link
In the original component folder (you may need to use sudo
):
$ npm link
Create a test package
Create a root test folder and then do the following:
$ create-react-app react-cognito-signup-test
$ cd react-cognito-signup-test
$ npm link @mitchallen/react-cognito-signup
Modify src/App.js
1: Add this line near the top:
import CognitoSignup from '@mitchallen/react-cognito-signup';
NOTE: CognitoSignup must be Capitalized or component won't render.
2: Somewhere in the middle of the render method add this line:
<CognitoSignup />
Run The Test App
$ npm start
Cleanup
Remember to unlink when done.
Repo(s)
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
Version History
Version 0.1.9
- Replaced updateUserToken with userHasAuthenticated
Version 0.1.8
- Removed amazon-cognito-identity-js
Version 0.1.7
- Added
run: yard add react
to.circleci/config.yml
- react is now only a peer dependency
- Removed
react-router-dom
dependecy - Added mock parameters to test case
- Updated UI dependencies
Version 0.1.6
- Removed withRouter wrapper from export
- Temporarily removed example
Version 0.1.5
- Moved react-dom from dev dependencies to prod dependencies
Version 0.1.4
- Added home page to demo
- Fixed env vars in demo so they start with REACT_APP_ (or else they won't load)
Version 0.1.3
- Made pool parameters a requirement
- Added pool parameters to router call in demo
Version 0.1.2
- Updated example to use published package
Version 0.1.1
- initial release