@secondstaxorg/sscomp 1.0.4
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 +16 -0
- package/README.md +87 -0
- package/package.json +62 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
MIT LICENSE
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Secondstax
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
6
|
+
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
|
|
7
|
+
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
|
|
8
|
+
to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
11
|
+
|
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
|
|
13
|
+
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
14
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
15
|
+
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
16
|
+
IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="" rel="noopener">
|
|
3
|
+
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
|
|
4
|
+
</p>
|
|
5
|
+
|
|
6
|
+
<h3 align="center">@secondstax/sscomp</h3>
|
|
7
|
+
|
|
8
|
+
<div align="center">
|
|
9
|
+
|
|
10
|
+
[]()
|
|
11
|
+
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
|
12
|
+
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
|
13
|
+
[](/LICENSE)
|
|
14
|
+
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
<p align="center"> A react component library for secondstax.
|
|
20
|
+
<br>
|
|
21
|
+
</p>
|
|
22
|
+
|
|
23
|
+
## 📝 Table of Contents
|
|
24
|
+
|
|
25
|
+
- [About](#about)
|
|
26
|
+
- [Getting Started](#getting_started)
|
|
27
|
+
- [Deployment](#deployment)
|
|
28
|
+
- [Usage](#usage)
|
|
29
|
+
- [Built Using](#built_using)
|
|
30
|
+
- [TODO](../TODO.md)
|
|
31
|
+
- [Contributing](../CONTRIBUTING.md)
|
|
32
|
+
- [Authors](#authors)
|
|
33
|
+
- [Acknowledgments](#acknowledgement)
|
|
34
|
+
|
|
35
|
+
## 🧐 About <a name = "about"></a>
|
|
36
|
+
|
|
37
|
+
A react component library for secondstax
|
|
38
|
+
|
|
39
|
+
## 🏁 Getting Started <a name = "getting_started"></a>
|
|
40
|
+
|
|
41
|
+
Please visit the figma design for the components.
|
|
42
|
+
|
|
43
|
+
### Prerequisites
|
|
44
|
+
|
|
45
|
+
You need node installed on your machine.
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
node -v
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Installing
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
npm i @secondstax/sscomp
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 🎈 Usage <a name="usage"></a>
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
import React from 'react';
|
|
61
|
+
import { Button } from '@secondstax/sscomp';
|
|
62
|
+
|
|
63
|
+
const App = () => {
|
|
64
|
+
return (
|
|
65
|
+
<div>
|
|
66
|
+
<Button>Click me</Button>
|
|
67
|
+
</div>
|
|
68
|
+
);
|
|
69
|
+
};
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## ⛏️ Built Using <a name = "built_using"></a>
|
|
73
|
+
|
|
74
|
+
- [Reactjs](https://www.reactjs.com/)
|
|
75
|
+
- [Storybook](https://storybook.js.org/)
|
|
76
|
+
|
|
77
|
+
## ✍️ Authors <a name = "authors"></a>
|
|
78
|
+
|
|
79
|
+
- [@augani](https://github.com/augani) - Idea & Initial work
|
|
80
|
+
- [@markObuobi](https://github.com/kingmarkssx) - Main contributor
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
|
|
84
|
+
|
|
85
|
+
- Hat tip to anyone whose code was used
|
|
86
|
+
- Inspiration
|
|
87
|
+
- References
|
package/package.json
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@secondstaxorg/sscomp",
|
|
3
|
+
"version": "1.0.4",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"registry": "https://registry.npmjs.org/"
|
|
6
|
+
},
|
|
7
|
+
"repository": {},
|
|
8
|
+
"description": "A react component library for secondstax",
|
|
9
|
+
"main": "dist/cjs/index.js",
|
|
10
|
+
"module": "dist/esm/index.js",
|
|
11
|
+
"files": [
|
|
12
|
+
"dist"
|
|
13
|
+
],
|
|
14
|
+
"types": "dist/index.d.ts",
|
|
15
|
+
"scripts": {
|
|
16
|
+
"test": "echo \"Error: no test specified\" && exit 1",
|
|
17
|
+
"storybook": "start-storybook -p 6006",
|
|
18
|
+
"predeploy": "npm run build-storybook",
|
|
19
|
+
"deploy-storybook": "gh-pages -d storybook-static",
|
|
20
|
+
"build-storybook": "build-storybook"
|
|
21
|
+
},
|
|
22
|
+
"author": "augustus Otu, mark obuobi",
|
|
23
|
+
"license": "ISC",
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"@babel/core": "^7.19.6",
|
|
26
|
+
"@rollup/plugin-commonjs": "^23.0.2",
|
|
27
|
+
"@rollup/plugin-node-resolve": "^15.0.1",
|
|
28
|
+
"@rollup/plugin-typescript": "^9.0.2",
|
|
29
|
+
"@storybook/addon-actions": "^6.5.13",
|
|
30
|
+
"@storybook/addon-essentials": "^6.5.13",
|
|
31
|
+
"@storybook/addon-interactions": "^6.5.13",
|
|
32
|
+
"@storybook/addon-links": "^6.5.13",
|
|
33
|
+
"@storybook/builder-webpack4": "^6.5.13",
|
|
34
|
+
"@storybook/builder-webpack5": "^6.5.13",
|
|
35
|
+
"@storybook/manager-webpack4": "^6.5.13",
|
|
36
|
+
"@storybook/manager-webpack5": "^6.5.13",
|
|
37
|
+
"@storybook/react": "^6.5.13",
|
|
38
|
+
"@storybook/storybook-deployer": "^2.8.16",
|
|
39
|
+
"@storybook/testing-library": "^0.0.13",
|
|
40
|
+
"@types/react": "^18.0.22",
|
|
41
|
+
"@types/styled-components": "^5.1.26",
|
|
42
|
+
"babel-loader": "^8.2.5",
|
|
43
|
+
"react": "^18.2.0",
|
|
44
|
+
"react-dom": "^18.2.0",
|
|
45
|
+
"rollup": "^3.2.3",
|
|
46
|
+
"rollup-plugin-dts": "^5.0.0",
|
|
47
|
+
"typescript": "^4.8.4",
|
|
48
|
+
"webpack": "^5.74.0"
|
|
49
|
+
},
|
|
50
|
+
"dependencies": {
|
|
51
|
+
"@heroicons/react": "^2.0.12",
|
|
52
|
+
"@mdx-js/react": "^1.6.22",
|
|
53
|
+
"chart.js": "^3.9.1",
|
|
54
|
+
"dayjs": "^1.11.6",
|
|
55
|
+
"gh-pages": "^4.0.0",
|
|
56
|
+
"heroicons": "^2.0.12",
|
|
57
|
+
"react-chartjs-2": "^4.3.1",
|
|
58
|
+
"react-fast-marquee": "^1.3.5",
|
|
59
|
+
"react-is": "^18.2.0",
|
|
60
|
+
"styled-components": "^5.3.6"
|
|
61
|
+
}
|
|
62
|
+
}
|