shipnow-apolo 0.0.1
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 +41 -0
- package/dist/index.es.js +135304 -0
- package/dist/index.js +135424 -0
- package/package.json +117 -0
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Mercurio
|
|
2
|
+
> Shipnow's Design System implemented in React
|
|
3
|
+
|
|
4
|
+
## How to publish to npm
|
|
5
|
+
create a npm account, then ask for rights to contribute
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
1. npm login
|
|
9
|
+
2. update the version of the package.json, then commit and push it to master!
|
|
10
|
+
3. npm publish
|
|
11
|
+
4. remenber to update the webapp package.json with the new version of MERCURIO!
|
|
12
|
+
5. done!
|
|
13
|
+
```
|
|
14
|
+
## Getting Started
|
|
15
|
+
|
|
16
|
+
Run the following command using [npm](https://www.npmjs.com/).
|
|
17
|
+
|
|
18
|
+
### Running the library for development
|
|
19
|
+
|
|
20
|
+
Run the following command to start Storybook for component display and test:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
cd shipnow-apolo
|
|
24
|
+
npm start
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Using the library locally
|
|
28
|
+
|
|
29
|
+
First, you need to link Mercurio to your local node_modules npm repository.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
cd shipnow-apolo
|
|
33
|
+
npm link
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The command will build the library for distribution with [Rollup](https://rollupjs.org/), copy the resulting folder in the local node_modules folder, and make it available for other local projects.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
cd your-project-folder
|
|
40
|
+
npm link shipnow-apolo
|
|
41
|
+
```
|