@aleleba/ro-ut-ui 2.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/LICENSE +17 -0
- package/README.md +46 -0
- package/dist/index.js +1 -0
- package/package.json +95 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
Copyright (c) 2022 Alejandro Lembke Barrientos
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted to any person to obtain a copy
|
|
4
|
+
of this software and associated documentation files (the "Software"), to address
|
|
5
|
+
in the Software without restriction, including, without limitation, the rights
|
|
6
|
+
use, copy, modify, merge, publish, distribute, sublicense and/or sell except to its creator and to which he wishes or disposes, subject to the following conditions:
|
|
7
|
+
|
|
8
|
+
The above copyright notice and this permission notice will be included in all
|
|
9
|
+
copies or substantial portions of the Software.
|
|
10
|
+
|
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
12
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
|
|
13
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO CASE THE
|
|
14
|
+
THE AUTHORS OR COPYRIGHT HOLDERS SHALL BE RESPONSIBLE FOR ANY CLAIMS, DAMAGES OR OTHERWISE.
|
|
15
|
+
LIABILITY, WHETHER IN AN ACTION IN CONTRACT, TORT OR OTHERWISE, ARISING OUT OF,
|
|
16
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
17
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Ro-ut UI Library
|
|
2
|
+
|
|
3
|
+
This project is the React Library with storybook for Ro-ut.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
You will need to create a new .env file at the root of the project for global config.
|
|
7
|
+
This is an exaple of config.
|
|
8
|
+
```
|
|
9
|
+
#Library Name (Default: ui-library)
|
|
10
|
+
LIBRARY_NAME=ui-library
|
|
11
|
+
#External CSS (Default: false)
|
|
12
|
+
EXTERNAL_CSS=true
|
|
13
|
+
#External CSS NAME (Default: index.css)
|
|
14
|
+
EXTERNAL_CSS_NAME=other_name.css
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### For Development
|
|
18
|
+
In the terminal run:
|
|
19
|
+
```
|
|
20
|
+
npm run start
|
|
21
|
+
```
|
|
22
|
+
You will find the components on:
|
|
23
|
+
```
|
|
24
|
+
scr/components
|
|
25
|
+
```
|
|
26
|
+
You will find stories of storybook on:
|
|
27
|
+
```
|
|
28
|
+
scr/stories
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
This will start the app-library in development mode, also it have Hot Reloading!
|
|
32
|
+
Enjoy coding!
|
|
33
|
+
|
|
34
|
+
### For Production
|
|
35
|
+
In the terminal run:
|
|
36
|
+
```
|
|
37
|
+
npm run build
|
|
38
|
+
```
|
|
39
|
+
It will create a dist folder and run:
|
|
40
|
+
```
|
|
41
|
+
npm publish
|
|
42
|
+
```
|
|
43
|
+
This will publish on npm your package.
|
|
44
|
+
|
|
45
|
+
## Cheers
|
|
46
|
+
Hope you enjoy this proyect! Sincerely Alejandro Lembke Barrientos.
|