GithubHelp home page GithubHelp logo

project-example's Introduction

Project Readme

A short summary of what this project is directed at accomplishing is appropriate here. Something along the lines of project is the web service responsible for handling interactions with project-ios and project-android mobile clients.

This README should also include any specific build/deploying instructions

Docs/

The docs directory should include any documentation related to the project. Specifically:

  • API Spec - Complete API documentation for any webservices or mobile apps that interact with web services.
  • Functional Spec - should be an up to date doc detailing all the features of the application, their api interaction, and user stories
  • Project Log - Contains notes from each team standup as well as release notes for each build

Some examples are in the docs directory, when documents are client supplied it is fine for these to be binary files (.doc/.pdf/etc...). When those documents are updated a explanitory change log message should accompany the commit that updates them so changes can be tracked effectively. For documents that we create, they should be in proper markdown format so that they can be viewed nicely on Github as well as be used for generating pdf documents to send back to the client

Design/

The design directory should include all design/intermediary assets for the application, this should include wireframes/mockups as well as any psd files with the completed designs. These should be kept up to date such that someone should be able to resume development on the project after a potentially a long period of activity without missing any source assets (and without needing access to a dropbox folder or old emails). Changes should be accompanied by meaningful change log messages so we have record of the project changes in design. This should not be the directory for project assets to be included in XCode.

project-example's People

Contributors

aditshukla avatar jnjosh avatar kconner avatar rachitshukla avatar spenrose avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

project-example's Issues

Segment control in navigation bar

Segment control should include "New Releases", "Top Tens" and "Genres"

  • The user can tap on the "Top Tens" or "Genres" segment button to go to 1.2.1 and 1.2.2 respectively

Check token expiry and redirect to 1.3

  • The user launches the app and is routed to (1.2 Home), but the Access Token has expired or has been revoked.
    • The user is returned to 1.1 and then sent to (1.3 Login)

Note: token will be checked using background process so the home view will need respond to an appropriate NSNotification by pushing on the login

Display list of new release albums

  • The user can view a list of new release albums sorted by date
    • The user can see the album title, artist, average rating, rating count, and album art

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.