Skip to content

Application Design

Jump to bottom
Owen Buckley edited this page Oct 30, 2018 · 3 revisions

The Application Design intends to capture the features and functionality of the main UI, https://www.contributary.community, and to interact with it.

Status

The aim of this document is to build up a reference of general features and capabilities. Certain features may be marked with a status, that might indicate a unique level of acceptance:

  • Proposal - Just an idea, not yet planned, speced, or scoped
  • Spec - An issue has been made and is currently being groomed for development
  • Live - Exists as a feature in the current product
  • Blocked - Dependant on another task

Right now, only short term goals will be in consideration for development, which are any features that don't require access to user_ specific information like profile data, starred repos, etc. ) Long term goals have been captured at the end of this document for reference.

Application Overview

The application will follow the architecture of a typical Single Page Application, with the main focus being on the landing page, which will support the bulk of the user experience. Like Twitter, there will be other pages (About, Contact) but it is expected a bulk of the activity will happen on the main landing page.

Designs / Styleguide

// XXX TODO (help please!)

Pages

Home

Status: Blocked (designs)

Where all the action is. This page provides the basic experience to all users

  1. Search for a programming language
  2. Search for a project
  3. Search for a repository
  4. Browse issues

Features

  1. Issues should display relevant meta data like labels (in a nice card style dropdown / shelf?)
  2. Filter options can include
    • Only showing issues with the label good first issue
    • ???

About

Status: Proposal https://github.com/ContributaryCommunity/www.contributary.community/issues/10

Contact

Status: Proposal https://github.com/ContributaryCommunity/www.contributary.community/issues/11

Common

Interactions common to multiple pages in the application.

Header

Status: Blocked (designs)

Footer

Status: Blocked (designs)

Navigation

Status: Blocked (designs)

Long Term Goals

TODO

Clone this wiki locally