0.1.0 • Published 4 years ago
rtn-dsm-components v0.1.0
What is this repository for?
- Quick summary
- Version
- Repo is for rtn-dsm-components. The small reusable components for the DSM
- Version v1.0.0
How do I get set up?
- Summary of set up
- Configuration
- Dependencies
- Database configuration
- How to run tests
- Deployment instructions
Familiarize yourself with Storybook:
- Familiarize yourself with Storybook: https://www.learnstorybook.com/introtostorybook
- great examples: https://github.com/storybookjs/design-system/tree/master/src/components
How to get running
- get a copy of the repo, and checkout a branch
- Configuration you'll need a .dsmrc home directory when you want to publish
- nvm install v14.14
- nvm v14.14
- npm i
- npm run storybook
- npm start
- components for dsm, go in the src/dsm-components directory
examples currently in the components directory
You can use npm link to test this during development
- Dependencies you'll need npm, node version v14.14 , use nvm
- Database configuration no database
- How to run tests npm test -u --watchAll
- How to run application just for view:
- npm start
- How to run storybook:
- npm run storybook
- How to run chromatic:
- npm run chromatic
- How to preview the storybook to dsm
- npm run dsmstorybook:preview
- you need to be able to at least view the DSM components area. Editorial rights are nice, but not totally nessisary.
Deployment instructions this is an npm package @rtnweb/rtndsmcomponents, publish to npm
Contribution guidelines
- Writing tests write test inline with your js file, using the "test" in the filename like: comp.test.js
- Code review
- all tests must work, and please lint.
- each component must have a test of each story
- each component should have a story
- there should be 3 files, the js, test.js, and story.js - for the component
Other guidelines:
- currently publishing to DSM SANDBOX for now.
Who do I talk to?
- Repo owner or admin Evelyn Thomas ethomas@roadtripnation.com
- Other community or team contact Hossam Ali, Ahmed Baher Flag notifications
0.1.0
4 years ago