react-spring

(★ 29,134)

✌️ A spring physics based React animation library

  • .dockerignore
  • .git-blame-ignore-revs
  • .gitignore
  • .npmignore
  • .npmrc
  • .nvmrc
  • .oxfmtrc.json
  • .oxlintrc.json
  • CLAUDE.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • renovate.json
  • tsconfig.json
  • tsdown.config.base.d.mts
  • tsdown.config.base.mjs
  • turbo.json
  • vitest.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/pmndrs/react-spring

Downloads the entire project code from GitHub to your computer.

cd react-spring

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 -t react-spring .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 react-spring

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.
npm install @react-spring/web

Downloads and installs the libraries listed in package.json.

npm install @react-spring/three

Downloads and installs the libraries listed in package.json.

<img src="https://img.shields.io/npm/v/@react-spring/web.svg?style=flat&colorA=000000&colorB=000000" />

Type this command into your terminal and run it.

<img src="https://img.shields.io/npm/dm/@react-spring/web.svg?style=flat&colorA=000000&colorB=000000" />

Type this command into your terminal and run it.

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