Contents
Background
Contributing
Important Information
Installation
Dependencies
Demo Documentation Site
Background
This project can be thought of in terms of two main parts:
- The Demo and Documentation Site which is used to showcase the Component Library and provide documenation.
- The Component Library, with it's associated components, themes etc.
Contributing
Before contributing to this project, please have a look at the Contribution Guidelines.
Contribution Guidelines
The contribution guidelines cover various topic, including but not limited to:
- Branching Strategy
- Build processes
- Publishing and Deployment processes
- Etc.
Important Information
Pay attention to ag-Grids' terms of use and licensing before doing anything.
Ag-Grid
Installation
The component library package can be installed from the NPM package repository by using the following command:
npm install sagegrid --save
By installing the package, you get the following:
- React Components
- Base Stylesheet
- Utilities
Dependencies
The Component Library has several dependecies on other packages, and can be categories as follows:
Dependencies:
- deepmerge@^4.2.2
- uuid@^8.3.1
Peer Dependencies:
- react@^16.13.1
- react-dom@^16.13.1
- ag-grid-community@^23.1.0
- ag-grid-enterprise@^23.1.0
- ag-grid-react@^23.1.0
- styled-components@^4.4.1
You will need to install the following dependencies in your project, these are peer-dependencies of the component library and are all required.
npm install react@^16.13.1
npm install react-dom@^16.13.1
npm install ag-grid-community@^23.1.0
npm install ag-grid-enterprise@^23.1.0
npm install ag-grid-react@^23.1.0
npm install styled-components@^4.4.1
Demo and Documentation Site
The Demo and Documentation site can be accessed using the link below