Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.36 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.36 KB

FakeBookGraphQL

A fakebook is a form of musical notation that specifies the essential elements of a popular song: the melody, lyrics and harmony. The melody is written in modern Western music notation, the lyric is written as text below the staff and the harmony is specified with chord symbols above the staff.

This GraphQL api allows users to upload books and have the book stored into active storage

Schema

  • Book

    • Has many songs
    • pdf

  • Song:

    • Page in book
    • Title
    • Reference to the associated pdf
    • song start page
    • song end page
    • pdf

Geting Started

Before cloning the repo make sure you have ruby and rails installed on your machine

  • create tmp directory in storage
  • run bundle intall to install all ruby gems related to the project
  • run rails db:setup to migrate the database and seed it with data
  • run rails s
  • Go to localhost:4000/graphiql to interact with the GraphQL interface

How was file upload done ?

File upload was done by using the ruby gem apollo_upload_server. This gem generates a custom Upload type for GraphQL. This type doesn't meet the needs of active storage so you would need to declare a custom File scalar that would interact with ActiveStorage.

Testing

I used rspec in order to test individual models and there validation

  • run bundle exec rspec in order to run the test