soundwave

Version: 1.1.0

---

Table of Content

• Team-Members
• Overview
• Getting Started
• User Stories
• Deployed Appliation

---

Team Members

• Cody Green
• Trevor Dobson
• Daniel Pillay
• Darcy Knore

---

Overview

A back-end CRUD database application that allows the user to save a collection of songs to a database.

---

Getting Started

Begin by ensuring the following are in place:

• Download application repo and execute the following command in terminal:
  • npm install
    
• Create .env file with which includes the following:
  • SECRET='secret code here'
    
  • MONGODB_URI='database pointer here'
    that points to a local database or a deployed database (this application uses Mlabs on Heroku)
    

Basic application functionality:

CREATE

Create User
Type = POST
Route: /signup
Requires:

• Unique username
• Password
  

Ex:
{
  username: 'bill',
  password: 'password'
}

Create Song
Type = POST
Route: /addSong
Requires:

• Token
• Song Object:

Ex:
{
  Title: '',
  Artist: '', 
  Album: '',
  url: ''
}

READ

Type = GET
Route: /signin/signin
Requires:

• Username and password
• Returns a users song list

UPDATE

Type = PUT
Route: /update
Requires:

• Token
• SongID: required
• Song Object (Note: only 1 key:value pair is required to update)
  Ex:

{ 
  _id: '',
  newTitle: '',
  newAlbum: '', 
  newArtist: '',
  newUrl: ''
}

DELETE

Type = DELETE
Route: /remove
Requires:

• Token
• SongID

---

User Stories

User

• As a user, I want to Sign Up / Login in to my account securely
• As a user, I want to be able to able to Add, Delete, or Update a song on my collection
• As a user, I want my collection of songs to persist between each login

Developer

• As a developer, I want to create an application that is easy to read and uses REST'ful architecture
• As a developer, I want to create an application that allows the user to Sign Up / Login securely
• As a developer, I want to create an application that allows the user to perform meaningful CRUD operations to manage their songs
• As a developer, I want to create an application that allows the user to save content to a database

---

Deployed Application

https://soundwavecf.herokuapp.com/home.html