Rokwire is a mobile-first ecosystem composed of applications, microservices, and libraries.

Check out the resources below to get started as a Rokwire developer!

Below are the tutorials for the languages and tools that you will need to set up your local development environment.

• Front-end:
  • Getting Started with Flutter: https://docs.flutter.dev/get-started/install
• Back-end:
  • Tour of Go: https://go.dev/tour/welcome/1
  • Getting started with MongoDB: https://www.mongodb.com/docs/manual/tutorial/getting-started/
  • OpenAPI 3 Spec: https://swagger.io/specification/

T0 understand the process of contributing to Rokwire, check out the following documentation.

• CONTRIBUTING
• CONVENTIONS
• CODE_OF_CONDUCT
• detect-secrets

The applications built on the Rokwire platform are primarily mobile apps used by the University community. They are built using Flutter, a cross-platform development tool.

Illinois App - The official mobile app of the University of Illinois at Urbana-Champaign, providing University community members with access to all the features and information they need to navigate campus

The Rokwire platform is composed of both internally maintained Building Blocks and external, third-party services.

The Building Blocks are the services which enable the fundamental features of the Rokwire platform. They are all first-party services developed and maintained within the Rokwire open-source. They are primarily written in Go, however some are written in Python as well.

Visit the links below to learn more about each of the Building Blocks:

• Core Building Block - The central service responsible for managing the core data elements of the Rokwire ecosystem including users, authentication, authorization, applications, organizations, and client configurations
• Groups Building Block - Allows users to create groups with each other and interact through forum posts, events, and polls
• Notifications Building Block - Manages user notifications delivered through push notifications, emails, and in-app inboxes
• Polls Building Block - Allows users to create polls for other users to vote on
• Sports Building Block - Manages information about athletics teams and events
• Events Building Block - Manages data about events occurring on campus
• Content Building Block - Manages content to be displayed in client applications
• Rewards Building Block - Manages reward transactions and inventory
• Wellness Building Block - Manages user wellness data including Wellness Ring progress and Todo Lists
• LMS Building Block - Provides access to integrated Learning Management Systems
• Transportation Building Block - Manages transportation data including bus passes and campus parking
• Gateway Building Block - Provides a proxy for Rokwire clients to access various external systems

Libraries provide functionality that is shared across code bases. This helps to reduce repeated code, ensures consistency across projects, and improves security.

Application Libraries provide standard UI components, data models, service integrations, and utilities that are used across Rokwire client applications.

Visit the links below to learn more about each of the application libraries:

• Rokwire Flutter Plugin - Library including standard UI components and services for Rokwire apps

Service Libraries provide standard integrations, data models, and utilities that are used across Rokwire services.

Visit the links below to learn more about each of the service libraries:

• Core Auth Library - Library for request authorization using the Core Building Block services
• Logging Library - Library for standard logging and error handling

The following template repositories available to help quickly create a new application.

• Mobile Client: https://github.com/rokwire/app-template-flutter
• Building Block: https://github.com/rokwire/building-block-template-go