You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-19Lines changed: 16 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ A template project demonstrating how to build mini-apps using the [up-provider p
5
5
## Overview
6
6
7
7
This template showcases:
8
+
8
9
-[UP-Provider](https://github.com/lukso-network/tools-up-provider) implementation and wallet connection on the Grid
9
10
- Profile search functionality using Envio integration for fast querying
10
11
- Integrates the [@lukso/web-components](https://www.npmjs.com/package/@lukso/web-components) library for ready-to-use branded components
@@ -15,56 +16,53 @@ This template showcases:
15
16
## Key Features
16
17
17
18
### UP-Provider Integration
19
+
18
20
The template demonstrates how to:
21
+
19
22
- Connect to Universal Profile browser extension from the Grid
20
23
- Manage UP contexts on the Grid
21
24
22
25
### Envio Integration
26
+
23
27
Shows how to:
28
+
24
29
- Query the LUKSO Envio indexer
25
30
- Search for Universal Profiles
26
31
- Display profile information and images
27
32
28
33
### Web Components
34
+
29
35
Shows how to:
36
+
30
37
- Use the [@lukso/web-components](https://www.npmjs.com/package/@lukso/web-components) library to display profile card
31
38
32
39
### ERC-725.js
40
+
33
41
Shows how to:
42
+
34
43
- Use the [erc725js](https://docs.lukso.tech/tools/dapps/erc725js/getting-started) library to fetch profile data from the blockchain
35
44
36
45
## Getting Started
37
46
38
47
1. Install dependencies:
48
+
39
49
```bash
40
50
yarn install
41
51
```
52
+
42
53
2. Run the development server:
54
+
43
55
```bash
44
56
yarn dev
45
57
```
46
58
47
-
3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.(Note that the Grid context is not available in the local environment)
59
+
3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
48
60
49
61
4. Testing your mini-app on the Grid:
50
62
51
-
We're using `localtunnel` to test the mini-app on the Grid. This library helps us to generate a public URL that can be used to add the mini-app to the Grid.
52
-
53
-
> Alternatively, you can use free cloud deployment services like Vercel, Replit, etc.
54
-
55
-
Globally install `localtunnel`:
56
-
57
-
```bash
58
-
npm install -g localtunnel
59
-
```
63
+
Simply add your localhost url as a mini-app to your Grid!
60
64
61
-
In the second terminal, run:
62
-
63
-
```bash
64
-
lt --port <LOCALHOST_PORT>
65
-
```
66
-
67
-
You can use this URL to add the mini-app to the Grid.
65
+
> Alternatively, you can use free cloud deployment services like Vercel, Replit, etc. and use the url provided from those services.
68
66
69
67
## Project Structure
70
68
@@ -77,10 +75,9 @@ You can use this URL to add the mini-app to the Grid.
77
75
78
76
-[LUKSO Documentation](https://docs.lukso.tech/) - Learn more about developing on LUKSO
79
77
-[UP Browser Extension](https://docs.lukso.tech/install-up-browser-extension) - Install the Universal Profile Browser Extension
80
-
-[erc725js](https://docs.lukso.tech/tools/dapps/erc725js/getting-started) - Learn more about the erc725js library
78
+
-[erc725js](https://docs.lukso.tech/tools/dapps/erc725js/getting-started) - Learn more about the erc725js library
81
79
-[@lukso/web-components](https://www.npmjs.com/package/@lukso/web-components) - Learn more about the @lukso/web-components library
82
80
83
-
84
81
## Contributing
85
82
86
83
Contributions are welcome! Feel free to submit issues and pull requests.
0 commit comments