@alphland/dapps 1.0.0

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/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # @alphland/dapps
2
+
3
+ A comprehensive list of dApps on the Alephium blockchain, curated and maintained by [Alphland](https://alph.land).
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @alphland/dapps
9
+ ```
10
+
11
+ or
12
+
13
+ ```bash
14
+ yarn add @alphland/dapps
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ ```typescript
20
+ import { dapps, DappInfo } from '@alphland/dapps';
21
+
22
+ // Get all dApps
23
+ console.log(dapps);
24
+
25
+ // Filter by tag
26
+ const defiDapps = dapps.filter(dapp => dapp.tags.includes('DeFi'));
27
+
28
+ // Find a specific dApp
29
+ const ayin = dapps.find(dapp => dapp.url === 'ayin');
30
+
31
+ // Get verified dApps
32
+ const verifiedDapps = dapps.filter(dapp => dapp.verified);
33
+
34
+ // Get dApps with audits
35
+ const auditedDapps = dapps.filter(dapp => dapp.audits.length > 0);
36
+ ```
37
+
38
+ ## Data Structure
39
+
40
+ Each dApp contains the following information:
41
+
42
+ - **name**: Name of the dApp
43
+ - **description**: Full description
44
+ - **short_description**: One-liner description
45
+ - **tags**: Categories (DeFi, NFTs, Games, etc.)
46
+ - **verified**: Whether contracts are verified on Alephium
47
+ - **audits**: List of security audits
48
+ - **contracts**: Smart contract addresses
49
+ - **tokens**: Token information
50
+ - **links**: Social media and documentation links
51
+ - **media**: Logos, banners, and preview images
52
+ - **teamInfo**: Team and project information
53
+
54
+ ## Available Tags
55
+
56
+ - `Onramps`
57
+ - `Bridges`
58
+ - `DeFi`
59
+ - `Games`
60
+ - `NFTs`
61
+ - `Social`
62
+ - `DAOs`
63
+ - `Infrastructure`
64
+ - `Wallets`
65
+ - `Security`
66
+ - `Hashrate`
67
+ - `Stats`
68
+ - `ComingSoon`
69
+
70
+ ## TypeScript Support
71
+
72
+ This package includes full TypeScript type definitions.
73
+
74
+ ```typescript
75
+ import type { DappInfo, Audit, Contract, Links, Media } from '@alphland/dapps';
76
+ ```
77
+
78
+ ## Data Source
79
+
80
+ The data is sourced from the [Alphland repository](https://github.com/xbabyx/alphland) and is updated regularly.
81
+
82
+ ## Contributing
83
+
84
+ To add or update a dApp, please submit a PR to the [main repository](https://github.com/xbabyx/alphland).
85
+
86
+ ## License
87
+
88
+ MIT
@@ -0,0 +1,2 @@
1
+ import { DappInfo } from './types';
2
+ export declare const dapps: DappInfo[];