LogoLogo
PAO DocsCommunity DocsInfrastructure DocsPeerplays.com
  • Developer Documentation
  • API Reference
    • Peerplays Core API
      • Popular API Calls
      • Account History
      • Asset API
      • Block API
      • Crypto API
      • Database API
      • Network Broadcast API
      • Network Nodes API
      • Orders API
    • Wallet API
      • Account Calls
      • Asset Calls
      • Blockchain Inspection
      • General Calls
      • Governance
      • Privacy Mode
      • Trading Calls
      • Transaction Builder
      • Wallet Calls
    • Bookie API
      • General Calls
      • Listeners
      • Tournaments
  • Peerplays API Libraries
    • Python Peerplays
      • Installation
      • Creating an Account
      • Creating a Peerplays Wallet
      • NFT API
      • Marketplace API
      • Role Based Permissions API
  • Development Guides
    • Creating User Issued Assets
    • Introduction to Permissions
    • NFT Minting
    • Calculating Costs
  • The Cookbook
    • NFTs for Staking Creator Tokens
  • Tools and Integrations
    • PeerID
      • 1.0.0
        • Infrastructure
          • Deployment on a Linux Serve
          • Deployment to AWS ECS
            • Building the Docker Images
            • Storing Secrets in Amazon Parameter Store to use in ECS
            • Creating the Task Definition
            • Creating the Cluster
            • Creating the Service
        • Development
          • How does PeerID work without storing the keys ?
          • Authentication with PeerID
          • Brain Storming
          • Software Requirements
      • Authentication with PeerID
      • Requirements Specification
    • Random Number Generator
      • RNG Technical Summary
      • RNG API
  • Supporting & Reference Docs
    • Peerplays Development FAQs
    • Sidechain Operator Node (SON) Development
      • Generic Sidechain Docs
        • Quick joining GLADIATOR
        • Changes to Peerplaysjs-lib
        • Requirements Specification
        • Low Level Designs
          • bitcoin-deposit-handling-lld
          • bitcoin-operations-draft
          • bitcoin-sidechain-handler-lld
          • bitcoin-sidechain-multisig-bitcoin-wallet-and-bitcoin-addresses-pw
          • bitcoin-withdrawal-handling-lld
          • btc-address-scripting-mechanism
          • comparison-between-scenarios-for-handling-deposits-and-withdrawals
          • exchange-rate-list
          • generic-sidechain-deposit-hld
          • generic-sidechain-high-level-design
          • generic-sidechain-listener-hld
          • generic-sidechain-withdrawal-hld
          • refund-btc-mechanism
          • son-configuration
          • son-consensus-communication-and-transaction-signing-on-chain-lld
          • son-de-register-proposals-lld
          • son-objects-and-operators
          • son-rewards-lld
          • son-voting-lld
          • son-wallet-list_sons-lld
          • creation of a multi-sig bitcoin address lld
          • claiming initial son vesting lld
          • changeover and SON maintenance scenarios lld
          • user-sidechain-addresses-mapping
          • wallet-commands-for-son
        • Functional Specs
          • SON Configuration
          • SON rewards
          • SON Voting and Consensus
          • SONs switchover scenarios
          • SON Status Operations & Monitoring
          • Proposals
          • SON Smart Contracts
      • Bitcoin Sidechain Docs
        • Functional Specs
          • btc-refunds
          • voting-and-consensus
          • son-switchover
          • son-rewards
          • son-proposals
          • son-configuration
          • heartbeat-monitoring
          • BTC Transaction Processing & Signing
          • Bitcoin Withdrawal Handling
          • Bitcoin Deposit Handling
          • SON Multisig Bitcoin Wallet
      • Hive Sidechain Docs
        • Functional Specs
          • HIVE Deposit Handling
          • HIVE Withdrawal Handling
    • Peerplays DEX Development
      • Peerplays NEX
        • Functional Specifications
          • NEX-FS01 Dashboard Page
            • NEX-FS12 ETH-SONs Deposit/Withdraw Functionality
          • NEX-FS02 Login and Account Creation
          • NEX-FS03 Menus and Nav
          • NEX-FS04 Notifications
          • NEX-FS05a Market Page (alpha)
          • NEX-FS05 Market Page
          • NEX-FS06 Profile Page
          • NEX-FS07 Wallet Functions
          • NEX-FS08 App Settings
          • NEX-FS09 Blockchain Page
          • NEX-FS10 GPOS Page
          • NEX-FS11 WhaleVault Integration
      • Requirements Specification
      • Functional Specs
        • Asset Info Page and Asset Lists
        • Dashboard
        • Exchange Page
        • Login and Account Creation
        • User Account Page
        • Voting Page
    • SPK Network
      • Functional Specs
        • Claimdrop Snapshot Functional Specification
        • Initial Claimdrop Functional Specification
    • NFT Development
      • NFT Store
        • NFT Store User Stories
        • NFT Store UI HLD
        • NFT Store Requirements Specification
        • Functional Specifications
          • APP-FS01 App Header
          • APP-FS02 App Body
          • APP-FS03 App Footer
          • APP-FS04 App Navigation
          • APP-FS05 Wallet Functions
          • APP-FS06 App Home Page
          • APP-FS07 Account Page
          • APP-FS08 Browse View
        • App Page List
        • Requirement Traceability Matrix
    • Operation IDs List
    • Sidechain Flow Diagram (HIVE coin)
    • Sidechain Flow Diagram (Bitcoin)
    • Sidechain Flow Diagram (Ethereum coin)
    • TradeHands Explorer
      • User Personas
      • User stories
      • APP-FS01 Detailed View
      • Draft: APP-FS02 Front Page
      • APP-FS03 Collection Details Page
    • Grafana
      • Grafana Installation
      • Install Grafana Behind reverse proxy
      • Loki Installation
      • Promtail agent Installation
      • Grafana Explorer
    • NEX Deployment & Configuration
      • NEX Deployment
      • NEX - Blockchain API configuration
      • Deploying NEX in a HA scenario
    • API Node
      • MarketCap API
    • TOTO Application
      • FS-Subscription Plan
      • FS-Achievements
  • Development Workflow Docs
    • Development Workflow
  • Other Documentation
    • Peerplays Home
    • Community Docs
    • Infrastructure Docs
    • Site Reliability Engineering
Powered by GitBook
On this page
  • 1. Purpose
  • 2. Scope
  • 3. Component
  • 4. Context
  • 5. Design Wireframe
  • 6. Requirements
  • A. Achievement Section
  • B. Achievement Levels
  • c. Achievement Indicator

Was this helpful?

Export as PDF
  1. Supporting & Reference Docs
  2. TOTO Application

FS-Achievements

1. Purpose

The purpose of this document is to explain the functionality expected for the achievement's page in the together application. The main focus is to describe about the achievement earned, user achievements, group achievements, multiple achievement levels.

2. Scope

The Functional specification document will describe the requirements, components involved, and basic design to be implemented.

3. Component

The proposed configuration, component, and the process flow covered in this document includes:

  1. Achievement logo

  2. Name of the achievement

  3. Image of the achievement

  4. An indicator level

  5. Achievement description

  6. Status bar

4. Context

The achievements are earned by users and groups (issues) by performing certain actions a specific number of times. User achievements are earned only by the actions completed by that user, whereas group achievements are earned by the combined actions of all members of the group. Often, achievements have multiple levels in many cases. Users and groups can level up achievements by performing the required action more times. Each subsequent level requires more actions completed than the last.

5. Design Wireframe

The below wireframes describes the various components and their designs for the together app.

6. Requirements

The requirement section explain in details about the requirements to develop achievement section at various levels in details.

A. Achievement Section

An achievement is the result of User's task accomplishment. For every task completion the user will be awarded with the respective badge. The below points should be followed while creating the UI design for achievement section:

A standard blank achievement image for achievements which haven’t yet been earned. Example Image shall be similar to the below image:

B. Achievement Levels

There are various levels of achievements based on the User's action. The achievement section consists of four categories namely Image, Name, Description, and Status bar. The below configuration must be followed while creating different achievement categories:

1. Name

The name of the achievement will vary based on the level reached by the user. The names that can be eared by users are Subscriber, Influencer, Professional Writer, Superstar, Supporter, volunteer, etc.,

2. Image

The image of the achievement will vary based on the level reached by the user. Each name earned by the user will have the image specific to that and should be updated as the User's levels alter. Example images are listed below:

3. Description

Each achievement earned has a unique description and the details should include the reason of achievement "What it's for?" and "How it's earned?".

4. Status Bar

A status bar (with numbers like “17/20”) shall be added below the description to indicate the number of actions required by the user to reach the next level.

The below diagram is an example of an achievement

c. Achievement Indicator

A user shall have any number of achievements based on their actions. So, each achievement must be displayed with the indicator to remind the number of actions required by the user to earn their achievements.

The below image is an example of achievements at various levels:

PreviousFS-Subscription PlanNextDevelopment Workflow

Last updated 1 year ago

Was this helpful?

Unearned Achievement Logo

The achievement design assets are located in the Figma page given below:

Achievement Level 1 (Name: Better With Two)
Achievement Level 2 (Name: Fist Bump)

The achievement names, actions, and levels are located in the spreadsheet below:

https://www.figma.com/file/KKi8eIqDaHrXMB0t6mL6NQ/Together-%7C-Discovery?type=design&node-id=1401-38276&mode=design&t=rAhpcLSH0LukbVaI-0
https://docs.google.com/spreadsheets/d/1TG8pLoylT-VbF9KRnGijxc3VdoKk3-lTvNXzxK3ux6c/edit#gid=2136638298
Achievement section in together app
List of achievement's logo
An Achievement example
Achievements to be earned