github-profile-trophy
π Add dynamically generated GitHub Stat Trophies on your readme
File Explorer
Download Latest Version (.zip)- close-old-issues.yml
- test-repository-action.yml
- testing.yml
- FUNDING.yml
- logo.png
- index.ts
- user_info.test.ts
- cache.ts
- Retry.test.ts
- Logger.ts
- Retry.ts
- Error.ts
- GithubRepository.ts
- index.ts
- notFoundUserMock.json
- rateLimitMock.json
- successGithubResponse.json
- githubApiService.test.ts
- request.test.ts
- GithubApiService.ts
- request.ts
- cache_manager.ts
- index.ts
- types.ts
- utils.ts
- EServiceKindError.ts
- index.ts
- Request.ts
- ServiceError.ts
- card.ts
- error_page.ts
- icons.ts
- theme.ts
- trophy.ts
- trophy_list.ts
- user_info.ts
- utils.ts
- test.ts
- .editorconfig
- .gitignore
- .vercelignore
- action.yml
- CONTRIBUTING.md
- deno.json
- deps.ts
- docker-compose.yml
- Dockerfile
- env-example
- LICENSE
- main.ts
- README.md
- render_svg.ts
- vercel.json
# Installation Guide
1. Get the code
git clone https://github.com/ryo-ma/github-profile-trophy
Downloads the entire project code from GitHub to your computer.
cd github-profile-trophy
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
// repository documentation
Was this content helpful?
(0 ratings)
