Difference between revisions of "Development/Summer of Code/2019/BookBrainz"

From MusicBrainz Wiki
(Design and implement a unified creation form)
(Web API)
Line 25: Line 25:
 
We do not want to impose a specific framework, but the url structure will aim to be harmonized with other MetaBrainz projects.
 
We do not want to impose a specific framework, but the url structure will aim to be harmonized with other MetaBrainz projects.
  
You will also write the accompanying tests, as well as a documentation that will be available for users.
+
You will be expected to use test driven development, as well as prepare a documentation that will be available for the public.
 
 
You will also learn to prepare the Docker image we will use to run the API in production, and how to integrate it to MetaBrainz’ hosting architecture.
 
  
 +
You will also participate in preparing the Docker image used to run the API in production, and how to integrate it into MetaBrainz’ hosting architecture.
  
 
=== Use Solr search engine ===
 
=== Use Solr search engine ===

Revision as of 13:33, 15 March 2019

This page will discuss the current list of suggested ideas for students to develop proposals for for Google's Summer of Code. If you're a student, feel free to base your proposal on one of these ideas, or pick and entirely new idea that you think might be useful to us.

Getting Started

(see also: Getting started with GSoC)

The first thing to do to get started with BookBrainz is to clone the bookbrainz-site GitHub repository, and follow the README.md file to get the site up and running.

Come and speak to us in the MetaBrainz IRC (freenode/#metabrainz) if you finish all of that, or get stuck at any point!

Ideas

Web API

Proposed Mentors: Monkey
Languages/skills: Node.js, PostgreSQL, Docker

Forum for discussion


BookBrainz currently does not have a way to programmatically query the database.

For this project, you will design a JSON web API, and implement it in NodeJS.

The design would clearly describe the result of each different query to the web API, and give examples of output. We do not want to impose a specific framework, but the url structure will aim to be harmonized with other MetaBrainz projects.

You will be expected to use test driven development, as well as prepare a documentation that will be available for the public.

You will also participate in preparing the Docker image used to run the API in production, and how to integrate it into MetaBrainz’ hosting architecture.

Use Solr search engine

Proposed Mentors: Monkey
Languages/skills: Node.js, Solr, (PostgreSQL, Docker)

Forum for discussion


BookBrainz currently uses ElasticSearch for its search engine, and we are aiming to replace it in favor of Solr.


This will simplify hosting BookBrainz on the same infrastructure as the other MetaBrainz projects and harmonize the technologies we use. ElasticSearch is also quite resource intensive and creating some issues for developers on slower computers.

A good understanding of NodeJS and ExpressJS is required to find and replace the relevant components in the web server.

You will set up Solr for use with Bookbrainz' schema, drawing inspiration from existing MusicBrainz code.

On the Node side, you will aim to reproduce the current search functionalities (have a look here ), including updating the Solr index on creation/modification of entities (as described in the docs . Currently this is done like this for ES). In addition, we would like to add pagination to the search page, which should be fairly simple to achieve with Solr.

Communicating with Solr can be done simply via HTTP requests. If needed, it could otherwise be done using a JS library if deemed suitable.

You will also be involved in the preparation of the production deployment, adapting existing Docker configurations from MusicBrainz.

Design and implement a unified creation form

Proposed Mentors: Monkey
Languages/skills: User interfaces, User Experience, React, Node.js

Forum for discussion

If you are familiar with BookBrainz, you will know that each entity has a separate creation form. You can see these in the website's menu bar under "+ Add".

This leads to a complex workflow for simple use cases (such as 'adding a book') and repeating data (for example the title of a work repeated for an edition and an edition group, in a simple use case of a book), increasing chances of making errors. Such an evident workflow should be straightforward (especially for inexperienced users), and we ask you to design and implement a single form that will improve the editing experience.

Tabs will likely be necessary to separate the different entities forms as steps. For each step, entities can be searched for or created, with the full range of options the current forms do. The form will automatically link together the various entities accordingly.

Keep in mind that "adding a book" is a simple case, and that we should be able to optionally enter more complicated cases (for example an anthology of short stories will have multiple Works, and the title of the Edition may be different from any of the Works it contains).

The first phase should be to make a mockup with a prototyping/wireframing tool such as Sketch, Figma or Pencil Project. You will be expected to develop the components using MetaBrainz' new React-storybook design system. We will work together iteratively during both the UX and development sections of the project.

User collections

Proposed Mentors: Monkey
Languages/skills: React, Node.js, User Experience, SQL

Forum for discussion

With all this data available, it would be great if BookBrainz users could use the website to save the books they have read, and mark the ones they would like to read.

This will allow to build a recommendation engine in the future, along with the integration with CritiqueBrainz.

You would develop a “Bookshelf” feature in the back-end of the website, writing tests as you go.

You would also design the React components and user experience on the front-end of the website, using a prototyping/wireframing tool and MetaBrainz' new React-based design system