Documentation
Get Started

Getting Started

Welcome to Apptuner, the ultimate solution for managing app maintenance notifications. This guide will walk you through the steps to get started with Apptuner, from signing up to creating projects and instances.

Sign Up

To get started with Apptuner:

  1. Visit the Apptuner Website: Navigate to the Apptuner signup page (opens in a new tab).
  2. Create an Account: Fill in the required details and create your account. Enjoy a 15-day free trial to explore all features.

Creating Projects

Once you have signed up:

  1. Login to Your Account: Use your credentials to log in.
  2. Navigate to the Console: After logging in, you will be directed to the console.
  3. Create a New Project:
    • Click on the "Add Project" button.
    • Enter name and a short description below 70 words for your project.
    • Click on the "Create" button.
    • Each project will be assigned a unique API key, which you will use for managing maintenance notifications.

Managing Instances

Inside each project, you can create multiple instances to handle different environments and app versions:

  1. Access Your Project: Click on the project you want to manage from your console.
  2. Create an Instance:
    • Click on the "Create Instance" button.
    • Enter the details for your instance. Instances can represent different environments (e.g., development, staging, production) or different app versions (e.g., seller app, customer app, delivery executive app).
    • Save your instance.

Example Use Cases

Different Environments

For an app with different environments:

  • Development: Create an instance for the development environment where you can test new features.
  • Staging: Create an instance for the staging environment for pre-production testing.
  • Production: Create an instance for the live production environment used by end-users.

Multiple App Versions

For an e-commerce platform with different user apps:

  • Seller App: Create an instance for the app used by sellers to manage their products.
  • Customer App: Create an instance for the app used by customers to browse and purchase products.
  • Delivery Executive App: Create an instance for the app used by delivery executives to manage deliveries.

Managing Maintenance Notifications

With your projects and instances set up:

  1. Navigate to an Instance: Click on the instance you want to manage.
  2. Configure Maintenance Notifications:
    • Reminder Start Time: Set the reminder start time to notify users in advance about the upcoming maintenance.
    • Maintenance Start and End Time: Set the start and end time for the maintenance period.
    • Toggle Status: Use the toggle button to activate or deactivate maintenance mode. During maintenance mode is active, a full-screen notification will be shown to users, informing them that the server is down. Users will not be able to access the app during the maintenance period.

By following these steps, you can effectively manage your app maintenance notifications with Apptuner, ensuring a smooth and informed experience for your users.

Happy tuning with Apptuner!