Skip to content

Commit 85493bf

Browse files
committed
initial migration from samples repo
0 parents  commit 85493bf

37 files changed

Lines changed: 843 additions & 0 deletions

.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
VITE_HOST_URL=http://localhost:3000

.gitignore

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
!.yarn/patches
2+
!.yarn/plugins
3+
!.yarn/releases
4+
!.yarn/sdks
5+
!.yarn/versions
6+
*.log
7+
*.tgz
8+
*.tsbuildinfo
9+
.DS_Store
10+
.env
11+
.eslintcache
12+
.git
13+
.hg
14+
.idea
15+
.pnp.*
16+
.rollup.cache
17+
.serverless
18+
.svn
19+
.tsconfig*
20+
.webpack
21+
.yarn/*
22+
build
23+
dist
24+
docs
25+
node_modules
26+
storybook-static

.npmignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
*.tsbuildinfo
2+
.*
3+
.aws
4+
.git
5+
.github
6+
.pnp.*
7+
.storybook
8+
.tsconfig*
9+
.vscode
10+
.yarn/*
11+
cspell.json
12+
docs
13+
rollup.config.ts
14+
storybook-static
15+
tsconfig*
16+
yarn.lock
17+
build

LICENSE

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# @xyo-network/xl1-protocol-samples-react
2+
3+
[![logo][]](https://xyo.network)
4+
5+
[![npm-badge][]][npm-link]
6+
[![npm-downloads-badge][]][npm-link]
7+
[![jsdelivr-badge][]][jsdelivr-link]
8+
[![npm-license-badge][]](LICENSE)
9+
[![socket-badge][]][socket-link]
10+
11+
XYO Layer One Protocol Sample Code
12+
13+
14+
15+
## Reference
16+
17+
**@xyo-network/xl1-protocol-samples-react**
18+
19+
***
20+
21+
## Functions
22+
23+
- [XL1BrowserSample](#functions/XL1BrowserSample)
24+
25+
### functions
26+
27+
### <a id="XL1BrowserSample"></a>XL1BrowserSample
28+
29+
[**@xyo-network/xl1-protocol-samples-react**](#../README)
30+
31+
***
32+
33+
```ts
34+
function XL1BrowserSample(): Element;
35+
```
36+
37+
## Returns
38+
39+
`Element`
40+
41+
42+
## Maintainers
43+
44+
- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
45+
- [Matt Jones](https://github.com/jonesmac)
46+
- [Joel Carter](https://github.com/JoelBCarter)
47+
- [Jordan Trouw](https://github.com/jordantrouw)
48+
49+
## License
50+
51+
> See the [LICENSE](LICENSE) file for license details
52+
53+
## Credits
54+
55+
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
56+
57+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
58+
59+
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-protocol-samples-react.svg
60+
[npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-protocol-samples-react
61+
62+
[npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/xl1-protocol-samples-react
63+
[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-protocol-samples-react
64+
65+
[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/xl1-protocol-samples-react/badge
66+
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/xl1-protocol-samples-react
67+
68+
[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/xl1-protocol-samples-react
69+
[socket-link]: https://socket.dev/npm/package/@xyo-network/xl1-protocol-samples-react

README_BODY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Getting Started
2+
3+
1. Install the dependencies: `yarn install`
4+
1. Start the sample website: `yarn run-sample-react`
5+
1. Visit the website it serves (i.e. http://localhost:3000)
6+
1. Follow the instructions on the sample page

global.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// eslint-disable-next-line import-x/no-internal-modules, unicorn/require-module-specifiers
2+
import type {} from '@mui/material/themeCssVarsAugmentation'

index.html

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
<meta charset="utf-8" />
6+
<!-- Hiding favicon so we don't see errors in console output of the `serve` command -->
7+
<!-- <link rel="icon" href="%VITE_HOST_URL%/favicon.ico" /> -->
8+
<meta name="viewport" content="width=device-width, initial-scale=1" />
9+
10+
<link rel="apple-touch-icon" href="%VITE_HOST_URL%/apple-touch-icon.png" />
11+
12+
<style>
13+
html {
14+
overflow-y: auto;
15+
overflow-x: hidden;
16+
}
17+
18+
body,
19+
#root {
20+
height: 100%;
21+
width: 100%;
22+
margin: 0;
23+
padding: 0;
24+
}
25+
</style>
26+
27+
</head>
28+
29+
<body style="padding: 0; margin: 0; overflow-x: hidden;">
30+
<noscript>You need to enable JavaScript to run this app.</noscript>
31+
<div id="root"></div>
32+
<script type="module" src="./src/root.tsx"></script>
33+
</body>
34+
35+
</html>

0 commit comments

Comments
 (0)