MudCats Echoes

Initial Set Up

1. npm install

2. Here are the instructions for installing and running postgresql: https://slack-files.com/T2SVC7RB3-F4HMU4URL-04fa832f88 Warning: these are instructions for installing postgresql on a Mac. If you have a windows computer, good luck?

3. Once psql is running, create your database

4. Navigate into the echoes directory in terminal

5. Enter: createdb echoes

6. Enter: knex migrate:latest

7. To access database in terminal: psql echoes

Highly recommended that you install Postico. Like DB Browser for SQLITE, it will allow you to view and interact with your database easily.

Inside the Knexfile

Utilizes postgresql. It is being run in db.js. You'll notice two environments: development and environment. If you are running the app locally on your computer, make sure 'env' in db.js is equal to development. If you are deploying on a site like heroku that can run it's own postgresql database, set 'env' to production.

While in development, if you wish to log the sql commands that knex runs in your terminal, uncomment 'debug:true'

Seed Files

Seed data is pre-fabricated data that allows you to interact with a filled database without making a billion calls to the API.

To use seed files:

1. Comment out all foreign key constraints in the migration file
2. Run: knex migrate:rollback followed by knex migrate:latest
3. Run: knex seed:run

To use data you get from creating your own users and grabbing data from the API:

1. Comment foreign key constraints back in
2. Run: knex migrate:rollback followed by knex migrate:latest

Viewing Console-Logs For Server Request

1. To view console logs for server request, go into the knexfile and uncomment 'debug: true'. Then, any time you make changes server side:
2. Run: npm start (This recompiles your changes, which is what the app is reading)
3. Exit out of npm start using ctrl-c (npm start, while running the server, will not show console logs)
4. Run: node server/server.js (This will restart the server w/o recompiling, but allows you to view your server-side console logs)

How to run website after initial setup complete

1. npm start the terminal will hang after compiling spec/serverSpec.js so then push ctrl-c
2. node server/server.js on the same terminal window after ctrl-c, leave this window running
3. Navigate to localhost:1337 on your browser

How to deploy app to Heroku

1. Create a heroku app and attach a postgresql add-on to it. That will automatically create the env var 'DATABASE_URL'
2. Recompile data by running npm start or in cl: babel . --watch --out-dir compiled --presets=es2015,react --ignore=node_modules,compiled --source-maps inline
3. Comment out 'compiled/' in gitignore
4. Make var env in db.js set to production.
5. git add/commit
6. Run: git push heroku master
7. If this is your first time setting up your database, run: heroku run knex migrate:latest
8. You're reading to go!

Stretch Goals

1. Implement a pages view so that you dont have to scroll continuously to view old albums
2. Implement a filter to rank albums by rating, date, or other criteria
3. Use the iTunes genius api or another service to recommend new albums a user may be interested
4. Add albums based on listening to a sound sample, like Shazam
5. Implement a more robust authentication system
6. Add a queue of new albums to checkout in the future
7. Integrate with Spotify so that when a new album is listened to that album is automatically added
8. Automate babel compiling
9. Add pop out module of albums (including list of songs for each album)