1.2.0 • Published 1 year ago
@beedigital-tech/bee-ds
Licence
—
Version
1.2.0
Deps
22
Size
845 kB
Vulns
0
Weekly
0
Bee Design System
A React Native design system with web support through react-native-web.
Installation
npm install @beedigital-tech/bee-ds
Development
Prerequisites
- Node.js (v20 or higher)
- npm or yarn
- Git
Setup
- Clone the repository:
git clone https://github.com/BeeDigital-AI/bee-ds.git
cd bee-ds
- Install dependencies:
npm install
- Run tests:
npm test
Publishing
This project uses GitHub Actions for automated package publishing. The workflow is triggered when pushing version tags.
Publishing Process
- Update the version in
package.json:
npm run publish:patch # for bug fixes
npm run publish:minor # for new features
npm run publish:major # for breaking changes
The GitHub Actions workflow will automatically:
- Run tests using
npm test - Build the package using
npm run build - Publish to npm registry using the NPM_TOKEN secret
Manual Publishing
If you need to publish manually:
- Login to npm:
npm login
- Build the package:
npm run build
- Publish:
npm publish
Environment Setup
Required Secrets
The following secrets need to be configured in your GitHub repository:
NPM_TOKEN: Your npm authentication token for publishing
Node.js Version
This project uses Node.js v20. The version is automatically set up in the CI/CD pipeline, but for local development, you can use nvm:
nvm use 20