star-history

(โ˜… 9,414)

The de facto GitHub star history graph.

  • .gitignore
  • .npmrc
  • CLAUDE.md
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • README.md

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/star-history/star-history

Downloads the entire project code from GitHub to your computer.

cd star-history

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • 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 build -f backend/Dockerfile -t star-history .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 star-history

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd frontend && pnpm i && pnpm dev

Moves into the project folder you just downloaded.

cd frontend && pnpm build:ext

Moves into the project folder you just downloaded.

cd backend && pnpm i && pnpm dev

Moves into the project folder you just downloaded.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation