Overview
The Psammead package library has migrated its components to a legacy folder in the Simorgh Single Page Application. Open source contributions should now be made via the Simorgh repository as the Psammead repository is no longer being maintained. The library contains components, containers, and utilities that are GEL-compliant and ready for use. There is extensive documentation available for understanding the code, contributing, and using the packages.
Features
- Components: GEL-compliant presentational React components
- Containers: Functional components for optional use with presentational components
- Utilities: Commonly shared dependencies and additional packages for building SPAs
Installation
- Clone the repository
- Install Yarn package manager
- Set up the local environment by running the
yarn install:packagescommand - Run tests using the
yarn testcommand - Build packages and components
- Refer to the documentation for further development and usage with Psammead
Summary
Psammead is a package library for React components, containers, and utilities. It has recently migrated its components to the Simorgh repository and is no longer being maintained in the Psammead repository. The library follows the GEL-compliant design and provides ready-to-use components along with extensive documentation for installation, usage, and contribution. Developers can clone the repository, set up the local environment, run tests, and build their own packages using Psammead.