@dnanpm/icons 2.0.0-alpha1 → 2.0.0-alpha2
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 +1 -35
- package/dist/sprite/spritesheet.svg.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,35 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
Export icons from a Figma file using the [Figma Icon Automation Plugin](https://www.figma.com/community/plugin/739395588962138807/figma-icon-automation). This repository contains scripts to pull icons from Figma, turn them into SVGs, create React component for each icon, bundle them into a package and finally publish to NPM.
|
|
4
|
-
|
|
5
|
-
## Development
|
|
6
|
-
Create a `.env` in the root directory. Put your Figma file url and Figma token inside.
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
FIGMA_FILE_URL=https://www.figma.com/file/********************/my-icons
|
|
10
|
-
FIGMA_TOKEN=********************************
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
### fetch SVG file
|
|
14
|
-
Run `npm run fetch` to fetch SVG files from Figma file. This will pull your SVGs in `./src/svg/`.
|
|
15
|
-
|
|
16
|
-
### Generate React components for icons
|
|
17
|
-
Run `npm run generate` to generate component files from SVG files. This will pull your component files in `./src/icons/`.
|
|
18
|
-
|
|
19
|
-
### Develop in local
|
|
20
|
-
Run `npm run dev` to develop the application in which you can see all icons.
|
|
21
|
-
|
|
22
|
-
### Build Github pages
|
|
23
|
-
Run `npm run build` to build Pages.
|
|
24
|
-
|
|
25
|
-
### Build npm package
|
|
26
|
-
Run `npm run build:bundle` to build publishable npm package.
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
copy .env-example to .env
|
|
34
|
-
generate figma token https://www.figma.com/developers/api#authentication
|
|
35
|
-
fill .env variables
|
|
1
|
+
TBD
|