@designcrowd/fe-shared-lib 1.2.6-debug-1 → 1.2.6-ml-291-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CLAUDE.md ADDED
@@ -0,0 +1,71 @@
1
+ # CLAUDE.md
2
+
3
+ This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
+
5
+ ## Development Commands
6
+
7
+ ### Starting Development
8
+ - `npm start` - Builds Tailwind CSS files for all themes and launches Storybook development server on port 6006
9
+ - `npm run storybook` - Same as `npm start` (alias)
10
+
11
+ ### Building
12
+ - `npm run build` - Builds production CSS using Tailwind
13
+ - `npm run build:css` - Builds CSS files using tailwind.build.js
14
+ - `npm run build:storybook` - Builds static Storybook for deployment
15
+
16
+ ### Code Quality
17
+ - `npm run lint` - Runs ESLint on TypeScript, JavaScript, and Vue files in src/
18
+ - `npm run lint:fix` - Automatically fixes linting issues where possible
19
+
20
+ ### Testing in UAT Environment
21
+ To test experimental versions without publishing to production:
22
+ 1. Update package.json version to `[current]-[description]`
23
+ 2. Run `docker build . --build-arg NPM_TOKEN=$NPM_TOKEN`
24
+ 3. Update consumer package reference to the new version
25
+
26
+ ## Architecture Overview
27
+
28
+ This is a shared component library and design system for DesignCrowd's frontend applications, published as `@designcrowd/fe-shared-lib`.
29
+
30
+ ### Project Structure
31
+ - **`src/atoms/`** - Reusable UI components (Button, Modal, Icon, etc.)
32
+ - **`src/experiences/`** - Complex, business-specific components (AuthFlow, PaymentConfig, etc.)
33
+ - **`src/themes/`** - Tailwind CSS theme configurations for different brands
34
+ - **`src/css/`** - Global CSS and Tailwind configuration
35
+ - **`public/css/`** - Generated CSS output files
36
+
37
+ ### Theme System
38
+ The library supports multiple brand themes through Tailwind CSS:
39
+ - **BrandCrowd** (`bc.js`)
40
+ - **BrandPage** (`bp.js`)
41
+ - **CrazyDomains** (`cd.js`)
42
+ - **DesignCrowd** (`dc.js`)
43
+ - **Design.com** (`dcom.js`)
44
+
45
+ Themes are built using `tailwind.themes.js` and exported via `src/themes/themes.js`.
46
+
47
+ ### Component Organization
48
+ - **Atoms**: Basic UI components with stories in Storybook
49
+ - **Experiences**: Complex components combining multiple atoms for specific workflows
50
+ - **Icons**: Extensive icon library with brand-specific variants
51
+ - **Mixins**: Reusable Vue.js mixins for common functionality
52
+
53
+ ### Key Files
54
+ - `index.js` - Main export file exposing all components
55
+ - `tailwind.config.js` - Tailwind CSS configuration
56
+ - `vite.config.ts` - Vite build configuration for development
57
+
58
+ ### Local Development Workflow
59
+ Use `npm link` in this directory and `npm link @designcrowd/fe-shared-lib` in consumer projects for local development.
60
+
61
+ ### Storybook
62
+ - Development server runs on port 6006
63
+ - Live Storybook: https://brandcrowd-storybook.s3.amazonaws.com/fe-shared-lib/live/index.html
64
+ - Stories are co-located with components (`.stories.js` files)
65
+
66
+ ### Brand Page Integration
67
+ For changes affecting BrandPage Tab in BC.NET:
68
+ 1. Update app.maker's reference to this library
69
+ 2. Bump app.maker version
70
+ 3. Run `npm run docker:publish:bp`
71
+ 4. Update BC.NET's reference to the new app.maker version
package/Dockerfile CHANGED
@@ -29,7 +29,7 @@ COPY .npmignore ./
29
29
  RUN npm run bundle-translation
30
30
 
31
31
  RUN mkdir artifacts
32
- RUN npm publish || touch artifacts/npm_publish_failed
32
+ RUN npm publish || (touch artifacts/npm_publish_failed && exit 1)
33
33
  RUN cp package.json artifacts/
34
34
 
35
35
  ENTRYPOINT ["/bin/echo", "Nothing to do."]