Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
Admin-Host committed Dec 23, 2024
1 parent e5932aa commit 2123215
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Admin-Host

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# LENS App

This is a template HTML/CSS/JS website that demonstrates how to use LENS for authentication.

## Prerequisites

- A web browser

## Installation

1. Clone the repository:

```sh
git clone https://github.com/LENSAuth/my-site.git
cd my-site
```

- 1a. Use as template:

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).

![Use this template](githubTemplate.gif)

## Running the App

1. Open `index.html` in your web browser.

## Project Structure

- `index.html`: Main HTML file that sets up the structure of the web page.
- `assets/script.js`: JavaScript file that handles the LENS authentication and popup window.
- `assets/style.css`: CSS file for styling the web page.
- `.gitignore`: Specifies files and directories to be ignored by Git.

## Usage

### Popup Window

- 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.
- When a message is received from the popup, it is logged to the console and displayed on the page.

## Notes

- Ensure that the domain you are using is registered with LENS. For testing purposes, you can register `localhost`.
- The browser logs the status and received data to the console.

## License

This project is licensed under the MIT License.
Binary file added githubTemplate.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2123215

Please sign in to comment.