@grantbii/design-system 1.0.0 → 1.0.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/README.md +9 -3
- package/app/layout.tsx +1 -1
- package/app/page.tsx +1 -1
- package/next.config.ts +10 -0
- package/package.json +4 -1
- /package/{core/index.ts → index.ts} +0 -0
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Based on Grantbii's Global Design Library in Figma.
|
|
|
7
7
|
Node 22
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
node -v # expected output: v22.
|
|
10
|
+
node -v # expected output: v22.xx.xx
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Set-up
|
|
@@ -32,6 +32,12 @@ The pages auto-updates as you edit the files.
|
|
|
32
32
|
|
|
33
33
|
## Develop
|
|
34
34
|
|
|
35
|
+
### Versioning
|
|
36
|
+
|
|
37
|
+
Bump version number in `package.json`
|
|
38
|
+
|
|
39
|
+
### Images
|
|
40
|
+
|
|
35
41
|
Use the `webp` format for images as it is lossless but more efficient than `png`.
|
|
36
42
|
|
|
37
43
|
Get started by installing [`cwebp`](https://developers.google.com/speed/webp/docs/cwebp).
|
|
@@ -42,8 +48,8 @@ Convert an image from `png` to `webp` like so:
|
|
|
42
48
|
cwebp -exact -lossless -progress your_image.png -o your_image.webp
|
|
43
49
|
```
|
|
44
50
|
|
|
45
|
-
##
|
|
51
|
+
## Publish
|
|
46
52
|
|
|
47
|
-
|
|
53
|
+
Publishing to NPM is automatic with [GitHub Actions](.github/workflows/continuous-delivery.yaml).
|
|
48
54
|
|
|
49
55
|
Once a commit has been made on the `prod` branch, a build would be triggered.
|
package/app/layout.tsx
CHANGED
package/app/page.tsx
CHANGED
package/next.config.ts
CHANGED
|
@@ -1,10 +1,20 @@
|
|
|
1
1
|
import type { NextConfig } from "next";
|
|
2
|
+
import path from "path";
|
|
2
3
|
|
|
3
4
|
const nextConfig: NextConfig = {
|
|
4
5
|
compiler: {
|
|
5
6
|
styledComponents: true,
|
|
6
7
|
},
|
|
7
8
|
devIndicators: false,
|
|
9
|
+
webpack(config) {
|
|
10
|
+
// preserve any existing aliases...
|
|
11
|
+
config.resolve.alias = {
|
|
12
|
+
...(config.resolve.alias ?? {}),
|
|
13
|
+
// map '@' → the design-system source folder
|
|
14
|
+
"@": path.resolve(__dirname, "node_modules/@grantbii/design-system/src"),
|
|
15
|
+
};
|
|
16
|
+
return config;
|
|
17
|
+
},
|
|
8
18
|
};
|
|
9
19
|
|
|
10
20
|
export default nextConfig;
|
package/package.json
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@grantbii/design-system",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "Grantbii's Design System",
|
|
5
|
+
"homepage": "https://github.com/grantbii/design-system",
|
|
6
|
+
"license": "UNLICENSED",
|
|
4
7
|
"scripts": {
|
|
5
8
|
"dev": "next dev --turbopack",
|
|
6
9
|
"build": "next build",
|
|
File without changes
|