README

Life Music

Mood-Generated Soundtracks

Create a profile, Pick your mood, Listen to music, Live your life

Description

A fullstack web application that uses a React front-end, a Ruby on Rails back-end and a PostgresQL database.

Challenges

• Creating custom serializers to display user view data.

• Integrating MUI dialog boxes.

• Client-side routing that works in unison with server side custom routes.

• Authentication/authorization using a session hash to allow user playlists to persist.

• Learning to use the React Material UI library.

• In the future I want to add:

  • Advanced audio player with autoplay and playlist features
  • Allow users to add their own music
  • Playlist editing capabilities
  • Auto-generated playlists by geo-location
  • Ability to rate songs

Project Repo

• GitHub [here] https://github.com/JawaraGordon/life-music

Navigating the application

✅ Email me for guest login credentials: [email protected]

🎵 Press the Music button.

✅ Choose a Mood from the Mood-bar to generate a random list of songs with that vibe.

✅ A new list of songs will be generated each time a Mood is pressed.

✅ Save the list of songs with the "save" button at the bottom of the playlist.

✅ View your saved playlists with the Playlists button.

✅ Press the Songs button at the top of the playlist to see a page with all of the songs or choose to see all of the songs categorized by mood.

✅ While on the music tab, press the "Time Hop" button next to the clock to generate a random list of songs based on the current time of day.

✅ Pressing the logo in the top left corner takes you to user's profile view.

Setup

src folder contains the following files:

../src/
├── App.css
├── index.css
├── index.js
└── components/
    ├── AboutDialog.js
    ├── AccountCard.js
    ├── App.js
    ├── BasicMenu.js
    ├── Clock.js
    ├── DeleteDialog.js
    ├── Header.js
    ├── Login.js
    ├── LoginForm.js
    ├── MoodBar.js
    ├── NavBar.js
    ├── SavePlaylistDialog.js
    └── SignUpForm.js
└── pages/
    ├── About.js
    ├── Account.js
    ├── AllSongs.js
    ├── Music.js
    ├── MyPlaylists.js
    └── SongsByMood.js
└── playlists/
    └── SongList.js
└── styles/
    └── index.js

index.js

import { BrowserRouter } from 'react-router-dom';

Imports BrowserRouter component from React Router, wraps App as the top level component.

Resources

• React Router

• This project was bootstrapped with Create React App.

React version

• 18.2.0

Ruby version

• 3.1.2

Rails version

• 7.0.3.1

Node version

• v18.7.0

Database

• (PostgreSQL) 14.4

System dependencies

• Homebrew
• npm
• rvm

• macOS 10+

• Windows 10+

Project dependencies

  emotion/react": "^11.10.0",
  emotion/styled": "^11.10.0",
  fontsource/roboto": "^4.5.8",
  mui/icons-material": "^5.8.4",
  mui/material": "^5.10.0",
  mui/styled-engine-sc": "^5.10.0",
  "react-dom": "^18.2.0",
  "styled-components": "^5.3.5"

Using Heroku

Windows Instructions here

macOS

$ brew tap heroku/brew && brew install heroku

$ heroku login

$ rvm install 3.1.2 --default
$ gem install bundler
$ gem install rails

Heroku requires Postgresql add 'pg gem' to Gemfile.

//Gemfile gem "pg", "~> 1.1"

Install Postgres.

$ brew install postgresql

$ brew services start postgresql

Rails App

Initiate a new git repository inside of your project directory using git init

Tell the app to use PostgreSQL.

$ rails new your-project-name --api --minimal --database=postgresql

This will configure our gemfile.lock to work with the same OS Heroku uses:

$ bundle lock --add-platform x86_64-linux --add-platform ruby

Build the app as normal

React App

Configure React to work in Rails production environment.

From the root directory:

npm install --prefix client

Create a Procfile in the root of your directory.

Add this code:

web: bundle exec rails s release: bin/rake db:migrate

Create a Procfile.dev in the root of your directory with the following:

web: PORT=4000 npm start --prefix client api: PORT=3000 bundle exec rails s

Create a React APP that is being served from Rails

$ npm run build --prefix client

Move the these files to public:

mv client/build/\* public

Configure client side routing

routes.rb

get "*path", to: "fallback#index", constraints: ->(req) { !req.xhr? && req.format.html? }

terminal

$ rails g controller fallback_controller

app/controllers/fallback_controller.rb

class FallbackController < ActionController::Base def index render file: 'public/index.html' end end

Deploy

Add a package.json to the root of your Rails app:

Add this code:

{
"name": "heroku-deploy",
"description": "Build scripts for Heroku",
"engines": {
"node": "15.6.0"
},
"scripts": {
"clean": "rm -rf public",
"build": "npm install --prefix client && npm run build --prefix client",
"deploy": "cp -a client/build/. public/",
"heroku-postbuild": "npm run clean && npm run build && npm run deploy"
}
}

$ heroku create

$ git add .
$ git commit -m 'Initial commit'

$ heroku buildpacks:add heroku/nodejs --index 1
$ heroku buildpacks:add heroku/ruby --index 2

$ git push heroku main

seed and migrate

$ heroku run rails db:migrate db:seed

open your heroku app

$ heroku open

See the url that your app is being hosted at

$ git config --list --local | grep heroku

run heroku locally

heroku local -f Procfile.dev

License

• MIT