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

A project like TaxonWorks needs diverse contributions from many to succeed over the long-term. Technically, TaxonWorks adopts a range of strategies to make it successful from a development standpoint, highlights include:

  • Open source - All elements of the project are open source under an MIT license.
  • Live technical support - Via weekly, year-round support meetings, online-chat, and video-conference on demand. Connect via Events.
  • Tests - TaxonWorks has extensive tests helping to maintain application cohesiveness and to prevent the introduction of errors.
  • Documentation - The project is well documented both here, and in code and everyone is encouraged to contribute to it.
  • Continuous integration (CI) - Code is tested and builds created via CI, meaning all contributions trigger tests, and builds can be deployed with minimal effort.
  • Code Generators - Stub a new task view (core feature) or batch-loader so that coding experiments can start instantly.
  • JSON API ("dogfooding") - TaxonWorks largely uses RESTful conventions, and a JSON serving back end that is nearly 1:1 accessible via a public-facing front end, this means if you can imagine using it externally, you can.
  • Containerized - TaxonWorks is available as a Docker container facilitating deployment, development, and local use.
  • Meta-projects - Example meta-projects exist, for example taxonworks_stats (demo) illustrating how to build an application off of the API
  • Rails - TaxonWorks is built on Rails, a framework used by Github, Shopify, and other major projects that produce web-applications. This ensure that there is a large, well established pool of potential expertise to draw from. It further provides a framework of conventions that facilitate maintenance over time.
  • Hackathons and Workshops - The Species File Group and its members have held hackathons and many in-house joint workshops. Contact them if you're interested in participating on site. They are also interested in supporting visits to would-be developers, students, or others wishing to get a boot-camp in TaxonWorks development.
Edit this page
Last Updated:
Contributors: mjy