Skip to content

Commit 5331009

Browse files
committed
docs: add comprehensive API key acquisition guides
- Create detailed step-by-step guide for obtaining every API key - Add quick reference card with checklist and links - Include comprehensive cost breakdown and optimization strategies - Create interactive setup script for environment configuration - Update README with new documentation structure This provides users with everything needed to obtain and configure all required services.
1 parent bb71d23 commit 5331009

File tree

6 files changed

+1119
-1
lines changed

6 files changed

+1119
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,13 @@ terraform apply
151151

152152
## 📚 Documentation
153153

154-
- [Environment Setup Guide](docs/ENVIRONMENT_SETUP.md) - Detailed guide for configuring all services
154+
### Setup Guides
155+
- [Environment Setup Guide](docs/ENVIRONMENT_SETUP.md) - Overview of environment configuration
156+
- [Get API Keys Guide](docs/GET_API_KEYS_GUIDE.md) - **Step-by-step instructions for every API key**
157+
- [Quick Reference Card](docs/API_KEYS_QUICK_REFERENCE.md) - Printable checklist with all services
158+
- [Cost Breakdown](docs/COST_BREAKDOWN.md) - Detailed pricing and optimization strategies
159+
160+
### Deployment & Development
155161
- [Deployment Guide](docs/DEPLOYMENT.md) - Step-by-step production deployment
156162
- [Production Roadmap](PRODUCTION_ROADMAP.md) - Implementation phases and timeline
157163
- [API Documentation](docs/API.md) - Backend API reference

docs/API_KEYS_QUICK_REFERENCE.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# API Keys Quick Reference Card
2+
3+
Print this page and check off each service as you complete it.
4+
5+
## 🚀 Essential Services (Required)
6+
7+
| Service | URL | Time | Cost | Notes |
8+
|---------|-----|------|------|-------|
9+
| **Convex** | https://www.convex.dev/ | 5 min | Free | Auto-generates deployment URL |
10+
| **Alchemy** | https://www.alchemy.com/ | 10 min | Free tier | For Ethereum & BSC RPC |
11+
| **QuickNode** | https://www.quicknode.com/ | 10 min | Free tier | Alternative to Alchemy |
12+
| **CoinGecko** | https://www.coingecko.com/en/api | 5 min | Free/Pro | Market data API |
13+
14+
## 🔑 Quick Commands
15+
16+
### Generate Auth Secret
17+
```bash
18+
openssl rand -base64 32
19+
```
20+
21+
### Create EVM Wallet
22+
```bash
23+
# Using Node.js
24+
node -e "console.log(require('ethers').Wallet.createRandom().privateKey)"
25+
```
26+
27+
### Create Solana Wallet
28+
```bash
29+
solana-keygen new --outfile ~/deployer-keypair.json
30+
```
31+
32+
## 📋 Checklist
33+
34+
### Day 1 - Core Setup (30 minutes)
35+
- [ ] Create Convex account
36+
- [ ] Generate AUTH_SECRET
37+
- [ ] Sign up for Alchemy/QuickNode
38+
- [ ] Get Ethereum RPC URL
39+
- [ ] Get BSC RPC URL
40+
- [ ] Get Solana RPC URL
41+
- [ ] Create deployer wallets
42+
43+
### Day 2 - Market Data (15 minutes)
44+
- [ ] Sign up for CoinGecko
45+
- [ ] Get CoinGecko API key
46+
- [ ] (Optional) Etherscan API key
47+
- [ ] (Optional) BscScan API key
48+
49+
### Day 3 - Social Media (Variable)
50+
- [ ] Create Discord webhook (2 min)
51+
- [ ] Create Telegram bot (5 min)
52+
- [ ] Apply for Twitter API (1-3 days wait)
53+
54+
## 🎯 Minimum Viable Setup
55+
56+
Just want to test? Use these free options:
57+
58+
```env
59+
# Minimum working configuration
60+
CONVEX_DEPLOYMENT=<auto-generated>
61+
VITE_CONVEX_URL=<auto-generated>
62+
AUTH_SECRET=<generate-with-openssl>
63+
64+
# Free public RPCs (less reliable)
65+
VITE_ETHEREUM_RPC_URL=https://eth.llamarpc.com
66+
VITE_BSC_RPC_URL=https://bsc-dataseed.binance.org/
67+
VITE_SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
68+
69+
# Test wallet (DO NOT use in production!)
70+
VITE_DEPLOYER_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
71+
```
72+
73+
## 💰 Estimated Costs
74+
75+
### Development/Testing
76+
- **Total**: $0/month (using free tiers)
77+
78+
### Production (Basic)
79+
- **Alchemy**: $0-49/month (free tier often sufficient)
80+
- **CoinGecko Pro**: $129/month (optional)
81+
- **Twitter API**: $100/month
82+
- **Total**: ~$100-250/month
83+
84+
### Production (Scale)
85+
- **Alchemy Growth**: $49-199/month
86+
- **CoinGecko Pro**: $129/month
87+
- **Twitter API**: $100/month
88+
- **QuickNode**: $49-299/month
89+
- **Total**: ~$350-750/month
90+
91+
## 🔗 All Services in One Place
92+
93+
### RPC Providers
94+
- **Alchemy**: https://www.alchemy.com/
95+
- **Infura**: https://www.infura.io/
96+
- **QuickNode**: https://www.quicknode.com/
97+
- **Ankr**: https://www.ankr.com/
98+
99+
### Market Data
100+
- **CoinGecko**: https://www.coingecko.com/en/api
101+
- **CoinMarketCap**: https://coinmarketcap.com/api/
102+
- **CryptoCompare**: https://min-api.cryptocompare.com/
103+
104+
### Block Explorers
105+
- **Etherscan**: https://etherscan.io/apis
106+
- **BscScan**: https://bscscan.com/apis
107+
- **Polygonscan**: https://polygonscan.com/apis
108+
- **Solscan**: https://solscan.io/
109+
110+
### Social Media
111+
- **Twitter Dev**: https://developer.twitter.com/
112+
- **Discord Webhooks**: Via server settings
113+
- **Telegram BotFather**: https://t.me/BotFather
114+
115+
### Storage
116+
- **Pinata**: https://www.pinata.cloud/
117+
- **Web3.Storage**: https://web3.storage/
118+
- **Fleek**: https://fleek.co/
119+
120+
## 🚨 Security Reminders
121+
122+
1. **NEVER** commit API keys to Git
123+
2. **NEVER** use your personal wallet as deployer
124+
3. **ALWAYS** use separate API keys for dev/prod
125+
4. **ALWAYS** set spending limits where possible
126+
5. **ROTATE** keys every 90 days
127+
128+
## 📞 Quick Support
129+
130+
- **Can't get Ethereum RPC?** → Use https://eth.llamarpc.com temporarily
131+
- **CoinGecko rate limited?** → Cache responses for 60 seconds
132+
- **Twitter API rejected?** → Be specific about token launch use case
133+
- **Wallet hacked?** → Revoke access immediately, rotate all keys
134+
- **High gas fees?** → Wait for low network activity (weekends)
135+
136+
---
137+
138+
**Save Time**: Set up services in parallel - while waiting for Twitter API approval, set up everything else!

0 commit comments

Comments
 (0)