TaxonWorks Docs
Guide
Develop
About
Start a project
Cite
API
Bug report
Contact
  • Docs
  • Code
  • API
  • English
  • Español
Guide
Develop
About
Start a project
Cite
API
Bug report
Contact
  • Docs
  • Code
  • API
  • English
  • Español
  • Develop
    • Overview
    • Contributing
    • Install
      • Development
        • Overview
        • Native
          • Operating Systems
          • Arch Linux
          • macOS
          • Ubuntu 22.04
          • Ubuntu 24.04
          • Windows 10 with WSL2
        • Docker
          • Build and push the development container to Docker
          • Docker
          • Windows 10 with WSL2
      • Production
        • Overview
        • Kubernetes
          • Overview
        • Capistrano
          • Overview
      • Overview
    • Code
      • Overview
      • Development Environment
      • Features
        • Scenarios
        • Scaffolding
        • Help bubbles
        • Rake task
        • Radial
        • TaxonWorks task
        • Tests
      • Conventions
      • Contributing
      • Troubleshoot
      • Roadmap
    • Data
      • Overview
      • Models
      • Tables
This site uses VuePress, a static site generator

Overview

Quickstart

  • Install Docker
  • Follow the instructions for using docker.

Tips

If your primary goal get TaxonWorks running locally so you can experiment with it, this is likely the fastest approach.

Warning

If you plan to code and develop, or check out the internals, installing via the Native approach will be more efficient for you

Environments

  • Native - You want to maximize performance, and are OK with getting your hands a little dirty
  • Docker - You want to write code against the API, make smaller changes, or run TaxonWorks locally
Edit this page
Last Updated:
Contributors: mjy
Next
Production