dorian1jay / jam_buddies Goto Github PK

jam_buddies's Introduction

jam_buddies

Documentation for jam buddies.

Want to give your overview of project

Jam Buddies is an android application that lets users(musicians) connect and interact to facilate musical interactions. A user creates a profile and gets authenticated through their email address. While creating a profile a user fills out a series of text fields (name,age, county , town/area ,Bio , instruments , experience , style, links to examples). Once a user has done this they can then search for other users profiles and message them . users can see message chats with everyone they interacted with in a similer way to whatsapp.

Document your design design here (why you chose one db over the other)

Sqlite vs JSON based firebase .

Usage guide to setup locally

Download the repositary to your computer . open using android studio .

to save time you can run the application on an android device instead of build an AVD. Device must be lollipop (5.1) or higher . On your android device go into setting -> about device -> build number . tap build number 7 times and a message should appear saying developer mode is enabled . After this go back to the settings menu enter developer option towards the bottom of the menu . Press enable developer mode then press enable usb debugging. connect your device via usb to your machine and android studio should pick it up when you try to run the application

After opening the login app in android studio ensure the click down menu under build on the second line is set to app . Its located between a green play button and a green hammer . click on the play button . select your android device and wait for it to build .

The formatting of this is markdown - google markdown for instructions. some change here

jam_buddies's People

Contributors

Watchers

jam_buddies's Issues

Approuch and methodology

Based on your background research from the previous sections, which approach are you going to take? This also includes project organization and your project plan for the duration of the project.

need to write this section

Database reading/writingspike

This will be part of profile page.

we want to test saving/retrieving information...
how does db work remotely - this is investigate too.

Authentication: Leverage firebase for authentication

Sign Up Pgage

Introduction

Project statement - containing overview of project , project objectives and project challenges

Login & Registration

This is the bucket list for stories required to complete the login and registration flow.

Final 3 sections of interim document

Evaluation ,Issues and Risks and Future Work each of these sections is not particularly big so i lumped them in together

Design

Please provide all technical design, i.e. any software design approach (waterfall, agile, etc.) and any use case diagrams, high or low fidelity prototype designs etc. are to be put into this section. Also, if you already have a prototype implemented, describe it here. Please use the following sub-sections:
a. System Requirements
Formal description of the system requirements.
E.g. Use Case diagrams / Use Case extended descriptions / UI design
b. System Design
Structural Design (Class Diagrams with Associations & Dependencies).
Behavioural Design (Sequence & State Diagrams).
Database Design (ER Diagram).
System Architecture (Minimal working prototype)

Searching and filtering user data

Epic related to saving and retrieving user data

Spike - test connecting to firebase. Report findings

Create a username/password login screen

Investigate if androids provides an out of the box solution for registering and signing in.