Introduction
Welcome to the cadent user management npm package. This package can be imported into any cadent application by just installing it as an dependency in the project. Cadent user management was built on react, redux and redux sagas. It currently allows you to manage (view, add, edit, archive, re-instate) users within the AWS cognito user pools.
Getting Started
- Installation Process
- Please have node, npm installed on your machine.
- Make sure to get access to the
user-management-web
repo. - Once you have access, git clone the project on your machine
git clone http://devvm01tfs03.telamericamedia.com:8080/tfs/CMWPA/Cadent%20Shared%20Resources/_git/user-management-web
- run
npm install
. - run
npm start
.
- NPM Package upgrade This project contains the build tools to turn the react project into an npm package that can be shared amongst all cadent applications. To update the npm package please follow these steps.
- Make sure that the
package.json
file in the root has all of the dependencies/ dev dependencies and to add them to thelib/package.json
file. (TODO: when updating the root package.json it will update the lib/package.json). - Mac Users: run the command
npm prepublish:deps
. - Windows Users: run the command
npm prepublish:build
. -
cd
into thelib
folder. - depending on the type of upgrade (patch, minor, major) run the command
npm run publish:patch
ornpm run publish:minor
ornpm run publish:major
.
Build and Test
Run npm test -u
or npm test
.