Skip to content

Commit 60743df

Browse files
committed
docs: udpate system features
1 parent 149f771 commit 60743df

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<summary>Key Features (Click to show details) </summary>
1717

1818
- **JWT Authentication** with refresh tokens and token blacklisting
19+
- **HashID URLs** with Base62 encoding for short, obfuscated public URLs
1920
- **Interactive Swagger Documentation** (170+ endpoints documented)
2021
- **Riot Games API Integration** for automatic match import and player sync
2122
- **Advanced Analytics** (KDA trends, champion pools, vision control, etc.)
@@ -111,6 +112,7 @@ open http://localhost:3333/api-docs
111112
- **Rails**: 7.2.0 (API-only mode)
112113
- **Database**: PostgreSQL 14+
113114
- **Authentication**: JWT (with refresh tokens)
115+
- **URL Obfuscation**: HashID with Base62 encoding
114116
- **Background Jobs**: Sidekiq
115117
- **Caching**: Redis (port 6380)
116118
- **API Documentation**: Swagger/OpenAPI 3.0 (rswag)
@@ -383,9 +385,12 @@ cp .env.example .env
383385
Edit `.env` with your configuration:
384386
- Database credentials
385387
- JWT secret key
386-
- Riot API key
388+
- Riot API key (get from https://developer.riotgames.com)
389+
- PandaScore API key (optional, for competitive data)
387390
- Redis URL
388391
- CORS origins
392+
- HashID salt (for URL obfuscation - keep secret!)
393+
- Frontend URL
389394

390395
4. Setup the database:
391396
```bash
@@ -747,12 +752,25 @@ open coverage/index.html
747752
Required environment variables for production:
748753

749754
```bash
755+
# Core
750756
DATABASE_URL=postgresql://user:password@host:5432/database
751757
REDIS_URL=redis://host:6379/0
758+
SECRET_KEY_BASE=your-rails-secret
759+
760+
# Authentication
752761
JWT_SECRET_KEY=your-production-secret
762+
763+
# External APIs
753764
RIOT_API_KEY=your-riot-api-key
765+
PANDASCORE_API_KEY=your-pandascore-api-key
766+
767+
# Frontend
754768
CORS_ORIGINS=https://your-frontend-domain.com
755-
SECRET_KEY_BASE=your-rails-secret
769+
FRONTEND_URL=https://your-frontend-domain.com
770+
771+
# HashID Configuration (for URL obfuscation)
772+
HASHID_SALT=your-secret-salt
773+
HASHID_MIN_LENGTH=6
756774
```
757775

758776
### Docker

0 commit comments

Comments
 (0)