Skip to content

Documentation

Jump to bottom
Damien Hobday edited this page Dec 8, 2016 · 6 revisions

SetUp

To set up project

    1. Create virtual environment - virtualenv venv
    1. Activate virtual env - source venv/bin/activate

    1. Install requirements from requirements.txt file

      pip install -r requirements.txt

What is PITCH

PITCH is an online platform that connects musicians and local venues. Venues include restaurants, bars or any events that require a musician or a band. Based on our user stories, most common way for musicians to find a gig is through word of mouth. This platform allows musicians to search for opportunities online and saves time.

Functionality of the website

The website requires user to register either as a Musician or a Venue. One logged in, Musicians

  • Post an event to look for musicians
  • Search for a musician based on their city, view their work and schedule an appointment Musicians are able to
  • Apply to events posted by venues
  • Post an advertisement to promote themselves Both users can schedule a meeting online.

User Interface

Wireframes for each page of the webite:

  1. Landing page

Wireframe for landing page includes a navigation bar at the top followed by an image. Landing page also includes information about upcoming events and who is playing based on location.

Navigation Bar on the landing page includes

  • Login
  • Register
  • About
  1. A user profile page

Navigation Bar includes

  • profile
  • Board (to see all the posted events/ads)
  • Log out Side bar includes TBD
  1. 3-click rule (no more than 3 clicks)
  • For venues: Landing page>profile page> Musicians interested in the events posted by, musicians ads etc
  • For Musicians: Landing page> profile page> Events posted and their ads etc

Milestones

Milestones to be achieved:

  • User Authentication
  • Wireframes
  • Landing page
  • Board app
    • Events posted by the venues
    • Ads/Jobs posted by musicians
    • Option to submit new events or Jobs
  • User authentication
  • Models for user accounts
  • Types of users (Musicians/Venues)
  • Templates
  • For user accounts
  • For board forms
  • For user update account forms
  • Forms to edit/update user profile
  • Feature to let musicians apply for events
  • Let venues select a musician

Implementation

  • Pitch's main functionality is implemented using Django models and foreign key constraints, which allow the models to essentially "talk" to each other.
  • Google's map API is used for the map functionalities.
  • Soundcloud integration is achieved using embedded features provided by Soundcloud.
  • Our calendar display is done using JQuery and JS.
  • A third party text app was used for text notifications.
Clone this wiki locally