https://github.com/dabapps/roe
DabApps' Project Development Kit
https://github.com/dabapps/roe
Last synced: about 1 year ago
JSON representation
DabApps' Project Development Kit
- Host: GitHub
- URL: https://github.com/dabapps/roe
- Owner: dabapps
- License: bsd-3-clause
- Created: 2017-04-24T10:31:15.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T10:48:26.000Z (over 2 years ago)
- Last Synced: 2025-04-13T09:12:57.036Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://dabapps.github.io/roe
- Size: 4.02 MB
- Stars: 4
- Watchers: 20
- Forks: 3
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 
**DabApps' Project Development Kit**
[](https://travis-ci.com/dabapps/roe)
## About
Roe is a project development kit developed by [DabApps](https://www.dabapps.com).
It is a collection of React components, styles, mixins, and atomic CSS classes to aid with the development of web applications.
## Documentation
Full documentation, examples, and installation / contribution instructions can be found [here](http://dabapps.github.io/roe).
## Contributing
Make sure you are using the correct version of node (12) and npm (7):
```
nvm use
npm i npm -g
# To install a specific version of npm
# npm i npm@7 -g
```
Install dependencies:
```
npm ci
```
Run the docs:
```
npm start
```
Run an examples page (for testing components):
```
npm run examples
```
Run all our tests, linting, etc:
```
npm test
```
Note: the above script will install several different versions of React types, so run `npm ci` once they're done to get back to the correct types.
Format all relevant files using prettier:
```
npm run prettier
```
## Code of conduct
For guidelines regarding the code of conduct when contributing to this repository please review [https://www.dabapps.com/open-source/code-of-conduct/](https://www.dabapps.com/open-source/code-of-conduct/)