https://github.com/mparticle/aquarium
mParticle Component Library
https://github.com/mparticle/aquarium
Last synced: 4 months ago
JSON representation
mParticle Component Library
- Host: GitHub
- URL: https://github.com/mparticle/aquarium
- Owner: mParticle
- License: apache-2.0
- Created: 2023-12-05T20:07:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-23T04:11:08.000Z (4 months ago)
- Last Synced: 2026-01-23T21:22:53.779Z (4 months ago)
- Language: TypeScript
- Size: 158 MB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# mParticle Aquarium
mParticle Component Library built on top of [Ant Design](https://ant.design/).
_Components That Scale_
## Installation
### Requirements
| Dependency | Version | Notes |
| ---------- | ----------- | ------------------------ |
| React | `>=17.0.2` | React 17 or 18 |
| React DOM | `>=17.0.2` | Must match React version |
| Node.js | `>=24.12.0` | For development |
### Quick Start
```bash
yarn add @mparticle/aquarium antd@5 dayjs@1
```
Or with npm:
```bash
npm install @mparticle/aquarium antd@5 dayjs@1
```
### Setup
Add the CSS reset to your app entry point (`_app.tsx`, `layout.tsx`, or `index.tsx`):
```typescript
import 'antd/dist/reset.css'
```
### Usage
```tsx
import { Button, Space, Typography } from '@mparticle/aquarium'
import { PaddingSm } from '@mparticle/aquarium/dist/style'
export const MyComponent = () => {
return (
Hello Aquarium
Successfully installed!
Primary
Default
)
}
```
## Development
Clone the repository and install dependencies:
```bash
git clone git@github.com:mParticle/aquarium.git
cd aquarium
npm install
```
Run Storybook for local development:
```bash
npm run storybook
```
Run unit tests:
```bash
npm run test-storybook
```
## Contributing
See [CONTRIBUTING.md](https://github.com/mParticle/aquarium/blob/main/CONTRIBUTING.md).
Please make sure any new or updated components are present, tested and verified within [Storybook](https://storybook.js.org/).
## Support
## License
mParticle's Aquarium is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). See the LICENSE file for more info.