Version: 1.1.0
- Team-Members
- Overview
- Getting Started
- User Stories
- Deployed Appliation
A back-end CRUD database application that allows the user to save a collection of songs to a database.
Begin by ensuring the following are in place:
- Download application repo and execute the following command in terminal:
- npm install
- 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)
- SECRET='secret code here'
Basic application functionality:
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: ''
}
Type = GET
Route: /signin/signin
Requires:
- Username and password
- Returns a users song list
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: ''
}
Type = DELETE
Route: /remove
Requires:
- Token
- SongID
- 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
- 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