Skip to content

Commit 2123215

Browse files
author
Admin-Host
committed
Add README and LICENSE
1 parent e5932aa commit 2123215

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Admin-Host
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# LENS App
2+
3+
This is a template HTML/CSS/JS website that demonstrates how to use LENS for authentication.
4+
5+
## Prerequisites
6+
7+
- A web browser
8+
9+
## Installation
10+
11+
1. Clone the repository:
12+
13+
```sh
14+
git clone https://github.com/LENSAuth/my-site.git
15+
cd my-site
16+
```
17+
18+
- 1a. Use as template:
19+
20+
To instead use this repository as a template for new projects, click the "Use this template" button on [the GitHub repository](https://github.com/LENSAuth/my-site), or click this link: [Create a new repository](https://github.com/new?template_name=my-site&template_owner=LENSAuth).
21+
22+
![Use this template](githubTemplate.gif)
23+
24+
## Running the App
25+
26+
1. Open `index.html` in your web browser.
27+
28+
## Project Structure
29+
30+
- `index.html`: Main HTML file that sets up the structure of the web page.
31+
- `assets/script.js`: JavaScript file that handles the LENS authentication and popup window.
32+
- `assets/style.css`: CSS file for styling the web page.
33+
- `.gitignore`: Specifies files and directories to be ignored by Git.
34+
35+
## Usage
36+
37+
### Popup Window
38+
39+
- The `index.html` file includes a script that opens a popup window to `https://lens.admin-host.com` and listens for messages from this origin.
40+
- When a message is received from the popup, it is logged to the console and displayed on the page.
41+
42+
## Notes
43+
44+
- Ensure that the domain you are using is registered with LENS. For testing purposes, you can register `localhost`.
45+
- The browser logs the status and received data to the console.
46+
47+
## License
48+
49+
This project is licensed under the MIT License.

githubTemplate.gif

23.9 KB
Loading

0 commit comments

Comments
 (0)