Skip to content

Commit

Permalink
Whoops forgot to add a file
Browse files Browse the repository at this point in the history
  • Loading branch information
spficklin committed Aug 28, 2018
1 parent b6ee052 commit 91834f6
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/dev_guide/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

Introduction to the Tripal API
==============================

Tripal provides an Application Programming Interfaces (API) that allows developers to interact with and customize Tripal. Using the API, developers can customize the way data is presented or create custom modules that provide new or different functionality. These custom modules can in turn be shared with the Tripal community. The Tripal API is documented online at http://api.tripal.info/api/tripal/3.x (COMING SOON). This document provides examples and best practices for using the Tripal API.

Requirements
-------------------------------

In order to use the Tripal API the developer should have the following skills:

Common skills:

* Knowledge of PHP.
* Knowledge of relational databases and SQL.

To create custom modules:

* Familiarity with Drupal API
* Familiarity with Drupal module development

To use Chado for data storage:

* Knowledge of Chado and relationships between tables (at least tables where data of interest is stored).
* An idea how data is stored in Chado (or a willingness to ask questions)

Things that will make your Tripal development experience postive, fun and rewarding:

* A desire to write code that can be re-used and shared by other groups
* A desire to share your work with others to support other the Tripal community members.
* A willingness to ask for help on the Tripal Github issue queue if you get stuck, find bugs or desire new features.

0 comments on commit 91834f6

Please sign in to comment.