Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 3.82 KB

README.md

File metadata and controls

109 lines (70 loc) · 3.82 KB
Raw

FlyScoop

Mobile monitoring and management app for Fly.io.

screenshot-1 screenshot-2 screenshot-3

Project Overview

FlyScoop aims to be a simple, useful, on-the-go management app for Fly.io accounts.

Rather than replicate the full functionality of the official web dashboards command-line tools, the goal is to support the most essential features necessary for fast mobile monitoring and management. Think of it as a companion to the oncall engineer's desktop environment, but not a replacement.

Features

  • List all of your apps
  • See a basic app overview
    • Last deployment name and date
    • Scale size
    • Basic metrics
  • View/follow app logs
  • Change app scale
  • Rollback / re-deploy a previous version
  • Drill down by region
    • Metrics
    • Logs
    • Instances

App Store Releases

The app has not yet been released to the iOS & Android app stores. Links to these releases will appear here.

For access to test builds (TestFlight, etc) please visit the Fly.io community thread.

Developer Guide

Orientation

This is a React Native app, targeting iOS and Android. It additionally uses the Expo framework, and Expo's EAS build service.

The initial entrypoint into the app is App.tsx. This module installs various (global) context providers and the initial view.

Code is organized into the following subdirs:

  • src/view/: Major screens of the app's UI.
  • src/component/: React components, used within views.
  • src/lib/: "Everything else"; typically non-React-specific classes and utilities.

Developer setup

To get started locally, use yarn to install all the package's various dependencies.

yarn

Then use yarn ios or yarn android to build and run the app. These commands will launch on either an emulator or on an attached device, depending on what's available and what options are provided.

Pre-commit and lint

A pre-commit configuration is included and, when installed in your local repo, ensures code is automatically formatted upon commit.

Use the following command to install the pre-commit hooks:

pre-commit install

Chores

Update TOC

Keep the table of contents in this doc nicely formatted, with:

yarn toc

Releases

TODO. Not yet sure how to share this.

Contributing

Contributions are very welcome, either in the form of code or ideas. Please go ahead and open an issue on GitHub to kick things off.

License

All code is offered under the MIT license, unless otherwise noted. Please see LICENSE.txt for the full license.

This project is neither endorsed nor affiliated with Fly.io, Inc.