Skip to content

Commit 2b81794

Browse files
committed
feat: update environment variables and enhance documentation structure
1 parent 7a05d6a commit 2b81794

6 files changed

Lines changed: 967 additions & 9 deletions

File tree

.env.example

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ WARMUP_USERNAME=pphatdev
77
# Cloudflare / Wrangler / D1
88
# Used by drizzle.config.ts when running Drizzle commands against D1.
99
# Keep these empty for local SQLite development.
10-
# CLOUDFLARE_ACCOUNT_ID=
11-
# CLOUDFLARE_D1_DATABASE_ID=
12-
# CLOUDFLARE_API_TOKEN=
10+
CLOUDFLARE_ACCOUNT_ID=
11+
CLOUDFLARE_D1_DATABASE_ID=
12+
CLOUDFLARE_API_TOKEN=
1313

1414
# Redis Cache Configuration (optional)
1515
# If not set, defaults to redis://localhost:6379

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Thank you for your interest in contributing to GitHub Stats! 🎉
44

5+
## Getting Started
6+
7+
Before contributing, please review:
8+
- [Project Structure](docs/PROJECT_STRUCTURE.md) - Understand the codebase organization
9+
- [Development Guide](docs/how-to/DEVELOPMENT.md) - Setup and development workflow
10+
511
## How to Contribute
612

713
### Reporting Bugs
@@ -35,7 +41,7 @@ We welcome feature suggestions! Please create an issue with:
3541

3642
To add a new theme:
3743

38-
1. Edit the appropriate file in `src/utils/themes/`:
44+
1. Edit the appropriate file in `src/shared/utils/themes/`:
3945
- `base.ts` - General-purpose themes (stats, languages)
4046
- `graph.ts` - Graph/heatmap optimized themes
4147
- `badge.ts` - Badge-specific themes

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -330,9 +330,10 @@ Project visitors increment once per same IP every 5 minutes.
330330

331331
## Development
332332

333-
Development setup was moved to: [docs/how-to/DEVELOPMENT.md](docs/how-to/DEVELOPMENT.md)
334-
335-
Route-by-route demos with option examples: [docs/example/README.md](docs/example/README.md)
333+
**Documentation:**
334+
- [Development Setup Guide](docs/how-to/DEVELOPMENT.md) - Environment setup, database, and run commands
335+
- [Project Structure](docs/PROJECT_STRUCTURE.md) - Complete codebase architecture and organization
336+
- [Route Examples](docs/example/README.md) - Route-by-route demos with option examples
336337

337338
## Architecture
338339

0 commit comments

Comments
 (0)