@saroj-parajuli/spsdesign
v0.1.0
Published
Shared SPS design system package with MUI exports, theme helpers, animations, and Sass assets.
Maintainers
Readme
SPSDESIGN
@saroj-parajuli/spsdesign is the shared SPS design system package extracted from the auth app design folder.
It currently ships:
- centralized MUI component exports
- shared icon exports and icon lookup helpers
- reusable MUI theme objects and style helpers
- Sass tokens, mixins, utilities, and shared auth styles
Install
Local workspace usage
{
"dependencies": {
"@saroj-parajuli/spsdesign": "file:../design"
}
}Then run npm install in the consuming project. If your local clone lives elsewhere, replace ../design with the correct relative path to this repository.
GitHub usage
{
"dependencies": {
"@saroj-parajuli/spsdesign": "git+https://github.com/saroj-parajuli/design.git#main"
}
}For SSH-based installs:
{
"dependencies": {
"@saroj-parajuli/spsdesign": "git+ssh://[email protected]/saroj-parajuli/design.git#main"
}
}Use
MUI exports
import { Box, Button, Typography } from '@saroj-parajuli/spsdesign/mui';Theme exports
import { ThemeProvider, CssBaseline, theme } from '@saroj-parajuli/spsdesign/theme';Sass entrypoint
@use '@saroj-parajuli/spsdesign/sass' as *;Build
npm install
npm run buildThe build outputs TypeScript bundles to dist/ and copies the raw Sass assets to dist/sass/.
Publish To npm
Before publishing, confirm that you own the npm scope used by the package name.
Current package name:
"name": "@saroj-parajuli/spsdesign"If you do not own the @saroj-parajuli scope on npm, rename the package before publishing.
Validate the package contents
npm run build
npm packPublish
npm login
npm whoami
npm publish --access publicBecause the package is scoped, public publishing requires --access public.
