spin
π Replicate your production environment locally using Docker. Just run "spin up". It's really that easy.
File Explorer
Download Latest Version (.zip)- bug.yml
- config.yml
- publish-prerelease.yml
- publish-stable-release.yml
- service_publish-node-package.yml
- sponsors.yml
- code_of_conduct.md
- dependabot.yml
- small-header.png
- spin-diagram.png
- spin
- spin-mcp-wait.sh
- .gitignore
- .gitignore
- spin.example.conf
- animations.css
- hamburger.css
- tailwind.css
- ClipboardIcon.vue
- CopyButton.vue
- PanelHeader.vue
- Pattern.vue
- Resource.vue
- ResourceIcon.vue
- AppButton.vue
- AppHeading2.vue
- AppHeading3.vue
- AppHeading4.vue
- AppLink.vue
- CodeGroup.vue
- CodePanel.vue
- Column.vue
- DiscordIcon.vue
- DocsIcon.vue
- FeatureGrid.vue
- GitHubIcon.vue
- GridPattern.vue
- Guide.vue
- Guides.vue
- HeartIcon.vue
- HeroPattern.vue
- HubMain.vue
- InfoIcon.vue
- LeadP.vue
- MarketingFollowAlong.vue
- MarketingGetStarted.vue
- MarketingGrid.vue
- MarketingHeader.vue
- MarketingHero.vue
- MarketingServers.vue
- MarketingShipFaster.vue
- MarketingVideo.vue
- Note.vue
- NotProse.vue
- Properties.vue
- Property.vue
- Resources.vue
- ResponsiveImage.vue
- Row.vue
- Search.vue
- VideoEmbed.vue
- Anchor.vue
- Aside.vue
- Eyebrow.vue
- Footer.vue
- Header.vue
- Logo.vue
- ModeToggle.vue
- Navigation.vue
- NavigationGroup.vue
- PageLink.vue
- Search.vue
- SmallPrint.vue
- Tag.vue
- TopLevelNavItem.vue
- DocsImage.vue
- MobileMenu.vue
- Discord.vue
- GitHub.vue
- Twitter.vue
- Anchor.vue
- Arrow.vue
- ChatBubbleIcon.vue
- Check.vue
- CheckIcon.vue
- ClipboardIcon.vue
- EnvelopeIcon.vue
- Moon.vue
- Resource.vue
- Search.vue
- Sun.vue
- UserIcon.vue
- UsersIcon.vue
- AppHeader.vue
- DocumentDrivenNotFound.vue
- PageHeaderLinks.vue
- states.ts
- useAssetUrl.ts
- 1.install-macos.md
- 2.install-windows.md
- 3.install-linux.md
- 4.install-composer.md
- 5.install-npm-yarn.md
- 1.get-help.md
- 2.testing.md
- 3.contributing.md
- 1.how-spin-works.md
- 2.create-a-new-project-with-spin.md
- 3.add-spin-to-an-existing-project.md
- 1.starting-up-your-development-environment.md
- 2.running-commands-in-development.md
- 1.server-requirements.md
- 2.server-configuration-basics.md
- 3.spin-yml-usage.md
- 0.digitalocean.md
- 0.hetzner.md
- 0.vultr.md
- 99.use-any-host.md
- 1.choosing-a-deployment-strategy.md
- 2.automated-deployments-with-github-actions.md
- 3.using-spin-deploy.md
- 1.connecting-to-your-server.md
- 2.troubleshooting-your-application.md
- 3.updating-your-server.md
- 2.generating-a-secure-ssh-key.md
- 3.adding-other-services.md
- 99.create-your-own-template.md
- migrating-from-spin-v2-to-v3.md
- base64.md
- build.md
- configure.md
- debug.md
- deploy.md
- down.md
- exec.md
- gh.md
- help.md
- init.md
- kill.md
- latest.md
- logs.md
- maintain.md
- mkpasswd.md
- new.md
- provision.md
- prune.md
- ps.md
- pull.md
- run.md
- stop.md
- up.md
- update.md
- vault.md
- version.md
- 1.index.md
- 0.laravel-basic.md
- 0.laravel-pro.md
- 0.nuxt.md
- hub.md
- index.md
- docs.vue
- hub.vue
- hubdetail.vue
- marketing.vue
- directory.ts
- pre-render-raw-routes.ts
- [...slug].vue
- [...slug].vue
- index.vue
- index.vue
- serversideup.png
- spin-laravel-basic.png
- spin-laravel-pro.png
- spin-new-community-template.png
- spin-nuxt.png
- api-sidebar.png
- generate-token.png
- token-scopes.png
- server-dns.png
- gha-secrets.png
- github-secrets.png
- secrets.png
- zero-downtime-deployment.png
- api-token-page.png
- generate-token.png
- select-project.png
- api-link.png
- api-token.png
- enable-api.png
- docker-compose-overrides.png
- docker-overrides-code.png
- spin-deploy.png
- spin-diagram.png
- spin-maintain.png
- spin-provision.png
- docker-accept-eula.png
- docker-desktop-configuration.png
- docker-info.png
- docker-installation-options.png
- docker-login.png
- docker-reboot.png
- docker-run-hello-world.png
- shell-linux.png
- shell-windows.png
- ubuntu-shell.png
- wsl-configure.png
- wsl-install.png
- android-chrome-192x192.png
- android-chrome-512x512.png
- apple-touch-icon.png
- browserconfig.xml
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- mstile-150x150.png
- safari-pinned-tab.svg
- site.webmanifest
- heart.svg
- search-icon.svg
- amplitude.svg
- server-side-up-footer.svg
- server-side-up-logo-horizontal.svg
- spin-logo.svg
- sevalla.svg
- github-actions.png
- social-image.jpg
- .env.example
- .gitignore
- .npmrc
- .nvmrc
- AGENTS.md
- app.config.ts
- app.vue
- content.config.ts
- error.vue
- nuxt.config.ts
- package.json
- README.md
- tailwind.config.js
- tsconfig.json
- typography.js
- yarn.lock
- base64.sh
- build.sh
- configure.sh
- debug.sh
- deploy.sh
- down.sh
- exec.sh
- gh.sh
- help.sh
- init.sh
- kill.sh
- latest.sh
- logs.sh
- maintain.sh
- mkpasswd.sh
- new.sh
- provision.sh
- prune.sh
- ps.sh
- pull.sh
- run.sh
- stop.sh
- up.sh
- update.sh
- vault.sh
- version.sh
- functions.sh
- core.blade.php
- COMMANDS.md
- DEPLOYMENT.md
- DOCKER-IMAGES.md
- LARAVEL-SERVICES.md
- SKILL.md
- TESTING.md
- TROUBLESHOOTING.md
- install.sh
- upgrade.sh
- .gitignore
- .npmignore
- AGENTS.md
- CLAUDE.md
- composer.json
- LICENSE
- package.json
- README.md
- SECURITY.md
# Installation Guide
1. Get the code
git clone https://github.com/serversideup/spin
Downloads the entire project code from GitHub to your computer.
cd spin
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
<a href="https://www.npmjs.com/package/@serversideup/spin"><img alt="npm" src="https://img.shields.io/npm/dm/@serversideup/spin?color=red&label=downloads&logo=npm"></a>
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.
3. PHP (Composer)
EasyPrerequisites
composer install
Installs the PHP libraries listed in composer.json.
Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.
// repository documentation
Was this content helpful?
(0 ratings)