Discover your perfect playlist with Character Chords, the app that combines the fun of taking a personality test with the joy of music exploration. Find new music that resonates with you, explore the fictional world of your favorite characters through music, and uncover real-life kindred spirits along the way. Let AI choose your next song for you based on your moral leanings, personality traits, and musical preferences!
- Directory
- Technical Details
- Getting Started
- Endpoints
- Database and Schema
- Photo Storage
- Goals
- Contributors
Character Chords is a full-stack Ruby on Rails app that uses a variety of technologies to provide a seamless and engaging music exploration experience. Here are some of the key technologies we use for the Back End service:
Ruby:Character Chords is built with Ruby, a powerful and dynamic programming language that is well-suited to web development.Ruby on Rails:This application is also built with Ruby on Rails, a powerful web framework for easy web development with APIs and data storage options.PostgreSQL:We used PostgreSQL for robust web application data storage and management.CircleCI:We use CircleCI for our continuous integration and continuous deployment (CI/CD) pipeline, which automates the testing and deployment of new code changes.Amazon S3:We utilize Amazon S3 for cloud storage, which allows us to securely store and manage user-generated content like playlists and user data.External APIs:We consume external APIs fromSpotifyandOpenAIto provide personalized music recommendations based on user preferences and personality traits.
Character Chords is a full-stack Ruby on Rails app that requires you to clone and set up both the frontend and backend repositories. You will need to ensure all required gems are installed and that environment variables are properly configured in order to run the app locally. Additionally, this app establishes API endpoints for use with the Character Chords Front End repository.
To get started, clone this repo down and install all gems by running:
bundle install
Next, run this command to make sure the database is properly created and migrated:
rails db:{create,migrate}
After running that command, inspect /db/schema in the application to make sure the database was properly created. This is what the schema should look like.
If you'd like to run the test suite for this repo, make sure you are connected to a server (either via the deployment on Heroku or localhost) and run this command:
bundle exec rspec spec
Example response using the lawyer quiz theme:
GET /chordsapi/v1/themes/:theme_id/characters is the setup
GET /chordsapi/v1/themes/2/characters is a bonafide query that should return the following:
[
{
"links": {
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/5/5d/Thurgood-marshall-2.jpg/220px-Thurgood-marshall-2.jpg"
},
"data": {
"type": "character",
"theme_id": 2,
"attributes": {
"name": "Thurgood Marshall",
"quiz": "lawyer",
"alignment": "Lawful Good",
"character_id": 10,
"description": "You are Thurgood Marshall, the legendary civil rights attorney and Supreme Court Justice..."
}
}
},
{
"links": {
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Amal_Clooney_02.jpg/1280px-Amal_Clooney_02.jpg"
},
"data": {
"type": "character",
"theme_id": 2,
"attributes": {
"name": "Amal Clooney",
"quiz": "lawyer",
"alignment": "Neutral Good",
"character_id": 11,
"description": "You are Amal Clooney, a lawyer and activist who..."
}
}
}, etc.
]NOTE: Response should return 9 Characters
Example response from the lawyer quiz theme using .5 for GOOD_EVIL_SCORE and .5 for LAWFUL_CHAOTIC_SCORE
GET /chordsapi/v1/themes/3/characters/find_character?good_evil=GOOD_EVIL_SCORE&lawful_chaotic=LAWFUL_CHAOTIC_SCORE is a sample query.
GET /chordsapi/v1/themes/3/characters/find_character?good_evil=0.5&lawful_chaotic=0.5is a bonafide query which whoudl produce the following results:
{
"links": {
"image": "https://upload.wikimedia.org/wikipedia/commons/b/b4/Robert-shapiro.jpg"
},
"data": {
"type": "character",
"theme_id": 2,
"attributes": {
"name": "Robert Shapiro",
"quiz": "lawyer",
"alignment": "True Neutral",
"character_id": 14,
"description": "You are Robert Shapiro (O.J. Simpson's lawyer), a true neutral..."
}
}
}NOTE: Pass numeric decimal values (1.0 - 0.0) for GOOD_EVIL_SCORE and LAWFUL_CHAOTIC_SCORE
Each theme is made up of 12 questions; this endpoint will provide the 12 questions for the theme_id passed through.
Example using the lawyer quiz theme id:
GET /chordsapi/v1/themes/:theme_id/questions is the format.
GET /chordsapi/v1/themes/2/questions is a bonafide query that should result in the following response:
{
"links": {
"image": "http://image.com"
},
"data": [
{
"type": "question",
"id": 1,
"attributes": {
"name": "A high-profile client offers you a significant sum of money to represent them in a case where they are clearly guilty. What do you do?",
"quiz": "lawyer",
"spectrum": "good_evil",
"answers": {
"A": {
"text": "Reject the case outright on moral grounds.",
"value": 1
},
"B": {
"text": "Accept the case but donate the earnings to charity",
"value": 2
},
"C": {
"text": "Accept the case and do your best to defend the client.",
"value": 3
},
"D": {
"text": "Accept the case and use any means necessary to win, even if it involves bending the truth.",
"value": 4
},
"E": {
"text": "Accept the case and actively participate in covering up the client's crimes.",
"value": 5
}
}
}
}, etc.
]
}NOTE: Response should return 12 Questions
GET /chordsapi/v1/themes/
{
"data": [
{
"type": "theme",
"id": 2,
"attributes": {
"name": "lawyer",
"image": "https://images.pexels.com/photos/3771097/pexels-photo-3771097.jpeg"
}
},
{
"type": "theme",
"id": 3,
"attributes": {
"name": "alignment",
"image": "https://images.pexels.com/photos/137049/pexels-photo-137049.jpeg"
}
}, etc.
]
} NOTE: Response should contain all Quizzes
create_table "characters", force: :cascade do |t|
t.string "name"
t.float "good_min"
t.float "good_max"
t.float "lawful_min"
t.float "lawful_max"
t.string "description"
t.bigint "theme_id", null: false
t.string "url"
t.integer "alignment", default: 1
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["theme_id"], name: "index_characters_on_theme_id"
end
create_table "playlists", force: :cascade do |t|
t.string "genre"
t.string "character"
t.string "alignment"
t.text "songs", default: [], array: true
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
end
create_table "questions", force: :cascade do |t|
t.bigint "theme_id", null: false
t.string "question"
t.string "answer_1"
t.string "answer_2"
t.string "answer_3"
t.string "answer_4"
t.string "answer_5"
t.integer "good_evil_chaotic_lawful", default: 0
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["theme_id"], name: "index_questions_on_theme_id"
end
create_table "sessions", force: :cascade do |t|
t.string "session_id", null: false
t.text "data"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["session_id"], name: "index_sessions_on_session_id", unique: true
t.index ["updated_at"], name: "index_sessions_on_updated_at"
end
create_table "themes", force: :cascade do |t|
t.string "name"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.string "image_link"
end
add_foreign_key "characters", "themes"
add_foreign_key "questions", "themes"The photos were first plucked from the internet (with best efforts being made to adhere to fair use) and are stored digitally in an S3 bucket run by Amazon Web Services cloud services.
- Create a web application that solves a real world problem and utilizes Service-Oriented Architecture (SOA).
- Implement authentication via OAuth and consume at least two other APIs.
- Develop a Rails "back end" API that acts as the interface layer to the database, handles API consumption, and uses Serializers.
- Gain professional development benefits such as experience working on a larger team, understanding the impact of changes on a system, and familiarity with SOA/multi-app systems.
- With additional time and resources, we would like to implement the ChatGPT API in at least two other locations in the project. First, in the creation of the questions and answers for quizzes. We would like for the user to be able to input a profession or a theme and then receive the relevant alignment questions based off of their input. As of the production of this project (April 2023), the API only supports Chat GPT3.5 and not 4.0, making longer and more complex queries more volatile based on user input.
- We would also like to implmenet DALL-E 2, the image generator of Open AI to provide a fictional album cover that is based off of the individual user's character selected and music genre. We would then upload the image to the user's Spotify playlist and send them the image in PDF format along with their playlist selection.
| Hady Matar | Harrison Ryan | James Taylor | Weston Sandfort |
|---|---|---|---|
 |
 |
 |
 |
 Github
 LinkedIn
|
Github
LinkedIn
|
Github
LinkedIn
|
Github
LinkedIn
|