Development

This page contains all of the information you need to get started developing for WPI Suite. Use it to find out how to contribute to the main WPI Suite framework or how to develop your own module to support new functionality.

Setting Up Your Development Environment This guide provides detailed instructions on how to setup your computer to develop for WPISuite.

Building WPI Suite Once you have your development environment setup, follow these instructions to build WPISuite on your machine.

Running WPI Suite TNG Locally These instructions explain how to run WPISuite on your own local Tomcat server. Make sure you have followed the instructions for building WPI Suite before attempting.

Project Layout This page provides a brief description of the purpose of each Eclipse project in the repository.

Repository Guidelines Rules to follow if you want to contribute to the project.

Step by Step Guide to Creating a Module This guide walks you through the process of developing a simple module from beginning to end. It is a good place to start if you want to develop your own module or just want to familiarize yourself with the WPISuite architecture.

Adding a Module This page describes how to add a shell module: the bare minimum classes required of WPISuite modules. If you're just starting out use the step by step guide above.

Networking with Janeway Learn how to make network requests in the Janeway client using the built-in network library.

Adding a Model (Data Entity) This page describes how to add a new data model to a WPISuite module. It primarily focuses on where the model needs to be registered in the core.

Advanced API The specification for the advanced API. This API is a supplement to the standard REST API that allows more advanced requests.

Build System Learn about how the build system works with Eclipse and Ant

WPISuite Troubleshooting & FAQ Find answers to troubleshoot issues and find solutions to common questions.