Project

API

Describe the feature you want to request

Currently @kat-kan is working on writing chapter summaries for the books.
As this is a huge task we decided it would be good to split this task in multiple minor projects.
Therefore I am asking you to work on some new chapters.

(Optional) Describe a solution for this feature

Decide a book (except book 1) you would like to work on an write own short summaries for each chapter of it.
As a reference for content and length you can checkout this discussion. There you will find some good examples to get an idea how the summaries should look like.
When you start working on the summaries, make sure which book you work on, so nobody works on the same book.
You can find the raw chapters here.

Project

Website (Potter DB Search)

Describe the feature you want to request

The API also gives data for Spells from the Harry Potter Universe.
Therefore there should be pages for spells on the website, too.

(Optional) Describe a solution for this feature

Create a page to list all spells (similar to the character list) and a general slug-based page for detailed information about a specific spells (such as here).
For the fetching of the data make sure to also create a new load_spells.js file similar to this one.

You also should link the spells page in the footer.

Make sure to have the same folder structure and layout as the other pages (characters and movies).

If you have any questions, feel free to leave a comment below.

Project

Website (Potter DB Search)

Describe the feature you want to request

It would be cool to have a page loading indicator to show the progress of loading the page.

(Optional) Describe a solution for this feature

Create a page loading indicator with nprogress.
The color of the loading bar should be #d500f9 and showSpinner should be set to false.

Project

Website (Potter DB Search)

Describe the feature you want to request

The API also provides data for Books and Chapters from the Harry Potter Universe.
Therefore there we should add pages for books, too.

(Optional) Describe a solution for this feature

Create a page to list all books (similar to the movie list) and a general slug-based page for detailed information about a specific book (such as here).

For the fetching of the data make sure to also create a new load_books.js file similar to this one, this should also fetch individual chapters of each book.

The AccordionList in the DetailsPage should contain the different chapters (e.g. name as and summary as the array content).

You also should link the books page in the footer.

Make sure to have the same layout and folder structure like other pages (characters, movies, spells, potions).

If you have any questions, feel free to leave a comment below.

Project

Website (potterdb.com)

Describe the feature you want to request

There could be a customized scroll bar for the website to make it look more amazing .

(Optional) Describe a solution for this feature

With out scrollbar it looks this this

If a custom scroll bar is added , it would look more magical

(Optional) Screenshots

![DESCRIPTION](LINK.png)

Project

Website (potterdb.com)

Describe the ticket you want to create

In building the new website (see new-website branch) we need your help.
This ticket is about creating the potions index (list/overview) and show (details) pages.

Get started

• Please add a short note below before starting with this ticket, so I can assign it to you.
• Fork this repo and make sure to branch up from new-website.
• Start implementing the features (see Acceptance Criteria).

You can get some inspiration by looking at the old potions page. But make sure to keep it in a similar style as the new character pages.

If you have any questions or concerns, feel free to ask below.

Acceptance Criteria

• Add the potion index and show page.
• Create skeleton animations that fit with the actual content.
• Make sure to split the content in useful components.
• Add metadata for SEO.
• Add /potions link in Footer.

Additional Details

https://github.com/danielschuster-muc/potter-db/tree/new-website/frontend/src/components/characters
https://github.com/danielschuster-muc/potter-db/tree/new-website/frontend/src/app/characters
https://beta.potterdb.com/characters

Screenshots

No response

Logs

No response

Project

API (api.potterdb.com)

Describe the ticket you want to create

Our API is currently missing an essential component - chapter summaries for the Harry Potter books.
I am aware this is a huge task and big effort that is why I decided to split it into multiple parts.

Get started

• Choose one of the books from Harry Potter you would like to write chapter summaries for and leave a notice below.
• Craft insightful chapter summaries that capture the essence of each chapter. The data for the books is located in backend/db/data/books. For inspiration look at this discussion.
• Submit your pull request and mention the book's title.

You can contribute chapter summaries for multiple books, but please work on one book (with all chapters) per pull request. If you want you can also work together with other on the same branch.

If you have questions or need guidance on formatting or content, feel free to engage in the linked GitHub discussion or ask for assistance on this issue.

Acceptance Criteria

• Choose a book and mention it below.
• Write concise, informative summaries for each chapter of your choosen book.

Additional Details

#170
Example

Books

Project

Documentation (docs.potterdb.com)

Describe the ticket you want to create

Jumping to "Security" section in README.md does not work
Jumping to "Authors & Contributors" section in README.md does not work

Acceptance Criteria

• update security link in readme.md
• update authors link in readme.md

Project

API (api.potterdb.com)

Describe the ticket you want to create

To enhance our API's flexibility, we want to introduce support for the JSON:API include field. This feature allows users to request related resources in a single API call, reducing the number of requests needed for complex data retrieval.

If you have any questions or concerns regarding this enhancement, reach out to me below.

Acceptance Criteria

• Modify our Ruby on Rails API, specifically using stas/jsonapi.rb, to support the include field for related resource inclusion.
• Update our REST API documentation to reflect the new functionality.
• Ensure that our OpenAPI documentation is consistent with the updated API behavior by updating the corresponding specs.

Additional Details

No response

Screenshots

No response

Logs

No response

Project

API

Describe the feature you want to request

Currently the chapters of each book don't have any summary at all.
Example: https://potter-db-api.herokuapp.com/v1/books/harry-potter-and-the-philosopher-s-stone/chapters

(Optional) Describe a solution for this feature

Write a short summarys of each chapter in the books which can be found here:
https://github.com/danielschuster-muc/potter-db/tree/master/backend/db/data/books

Project

Website (potterdb.com)

Describe the ticket you want to create

For the new website it would be nice to have a scroll to top button such as we had on the old website.

It should be positioned in the bottom right of the page and only be visible when needed (e.g. unless you are a the top of the page).
When clicked it should smoothly move the page to the top.
For the icon make sure to use react-icons. Do not use any other packages.

Please be aware to make a branch from the new-website branch.
Before start working on this ticket please leave a quick note below so I can assign you. If you have any questions please ping me.

Acceptance Criteria

• Add a ScrollToTop button that smoothly moves to the top of the page.
• It fits with our color theme (see tailwind.config.ts).
• It's only visible when needed.
• Works also for mobile usage.

Additional Details

No response

Screenshots

No response

Logs

No response

Project

Website (Potter DB Search)

Bug description

filter and sorting return 500 error, when i try get reques like https://api.potterdb.com/v1/characters?sort=-name or https://api.potterdb.com/v1/characters?filter[name_cont_any]=har

Expected Behavior

No response

Steps to reproduce

No response

Screenshots

![error](https://i.imgur.com/6drXFhV.png)

Logs

No response

Project

Website (Potter DB Search)

Describe the feature you want to request

Currently you can only search for characters. There should be also pages for Books, Chapters, Movies, Spells and Potions.

(Optional) Describe a solution for this feature

Create Pages in the style of the Character List and Detailed Character Page.
You can also suggest mockups below if you have any ideas for it, but don't know how to implement those pages.

Project

Website (Potter DB Search)

Describe the feature you want to request

So while using the website. I think it would improve the experience if there was a navbar.

(Optional) Describe a solution for this feature

Maybe changing the "General" , "Search" and "Information" options to a navbar could be a nice improvement to the website.

Project

Website (Potter DB Search)

Describe the feature you want to request

As there are more pages movies, spells and potions planned (see #210 and #209), we need more placeholder images for missing images.

(Optional) Describe a solution for this feature

Create your own (not copied) images for:

• characters
• movies
• spells
• potions
• books

Those images should be in a svg format, simple and silhouette of the respective topic, e.g. for characters a silhoutte of a (person with a wizard hat or something similar.
Don't just copy images from anywhere else, as I don't want any sort of copyright infringement and I therefore won't accept any PRs of that kind.

Project

Website (Potter DB Search)

Describe the feature you want to request

There current image which is used when there's no image for a character is really boring and was just quickly drawn by myself. Therefore it would be cool to have a better image instead.

(Optional) Describe a solution for this feature

Create an image with a silhouette of wizard/witch with a minimum size of 128x128 px (maximum 512x512, smaller would be better for performance) and replace the old image.

Project

Other (Please specify in the description)

Describe the feature you want to request

I would like to add docker to the project to have a single client, clean setup of the application locally. This could also be used to deploy those containers in production; if needed.

(Optional) Describe a solution for this feature

No response

Project

Website (Potter DB Search)

Describe the feature you want to request

Will be adding Trailer Links Of the Harry Potter and Fantastic Beast Movies

(Optional) Describe a solution for this feature

No response

Project

API (api.potterdb.com)

Describe the ticket you want to create

To simplify the process of contributing to our project, we're embarking on the journey of Dockerizing our backend/API. This means that contributors won't need to install Ruby or deal with complex setup procedures. Instead, they can effortlessly spin up the project environment using Docker containers.

Acceptance Criteria

• Create docker-compose.yml and Dockerfile to define the backend container.
• Include all necessary dependencies and configurations within the Docker container (e.g. Ruby on Rails and PostgreSQL)
• Update the README file to explain the new setup with docker.

Additional Details

https://docs.docker.com/get-started/

Project

Website (potterdb.com)

Describe the feature you want to request

I'd like to propose a new color palette for the website, based on the book colors and taking into account contrast rate focusing on accessibility.

(Optional) Describe a solution for this feature

I can make a prototype for review. If so, can I be assigned to it?

(Optional) Screenshots

![DESCRIPTION](LINK.png)

Project

API

Describe the feature you want to request

Basically add filtering for the GraphQL API and improve it in general.

(Optional) Describe a solution for this feature

See this for some ideas how it could be implemented.
Also if you have any ideas for improvements leave a comment on that discussion.

Project

Website (potterdb.com)

Describe the ticket you want to create

To improve the visuals of the new website, it would be nice to have a progressbar on page loading. I suggest using Next NProgress Bar. Be aware to branch off from new-website, see here for assistance.

Acceptance Criteria

• Install next-nprogress-bar and set it up using app/layout
• Adjust it to our color schema (use secondary color / #D926D9)
• Adjust options:
  showSpinner: false
  delay: 100
  shallowRouting

Additional Details

No response

Screenshots

No response

Logs

No response

Project

Website (potterdb.com)

Describe the ticket you want to create

Create the movies index and show pages.

Acceptance Criteria

• Add the movie index and show page.
• Create skeleton animations that fit with the actual content.
• Make sure to split the content in useful components.
• Add metadata for SEO.
• Add /movies link in Footer.

Additional Details

No response

Screenshots

No response

Logs

No response

Project

API

Bug description

I'm new to Ruby development, I've just installed Ruby and Ruby-on-Rails today. Unfortunatelly, I'm having troubles setting up the project. This is a blocker for me, I can't contribute to your project. Though I can try looking at the front-end part.

I'm following the instructions in the backend/README.md file.

rails db:create db:migrate

and this step fails with the following error:

what have I tried to fix it myself?

1. this

    gem install tzinfo-data

2. also, this https://stackoverflow.com/a/23816959/1429387
3. I've tried to run the command within MINGW64 git bash and in windows cmd prompt with Ruby

Expected Behavior

No response

Steps to reproduce

all steps are described in the backend/README.md file

Screenshots

Logs

$ rails db:create db:migrate
rails aborted!
TZInfo::DataSourceNotFound: tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile and run bundle install
D:/dev/hacktoberfest/potter-db/backend/config/environment.rb:5:in `<main>'

Caused by:
TZInfo::DataSources::ZoneinfoDirectoryNotFound: None of the paths included in TZInfo::DataSources::ZoneinfoDataSource.search_path are valid zoneinfo directories.
D:/dev/hacktoberfest/potter-db/backend/config/environment.rb:5:in `<main>'
Tasks: TOP => db:create => db:load_config => environment
(See full trace by running task with --trace)

Project

Documentation

Describe the ticket you want to create

To make our Potter DB accessible to a global audience, we're reaching out to contributors like you for help in translating our documentation into multiple languages.

Get started

• Please drop a quick note below to let us know which language you're working on. This helps us keep track of ongoing translations and prevents duplication of efforts.
• Clone the Repository and navigate to the docs folder within the repository.
• Translate the *.en.mdx files within the /pages directory and start translating them into your desired language.

If you encounter any challenges or need clarification while translating, don't hesitate to reach out to us. We're here to assist you every step of the way.

Acceptance Criteria

• Translate the documentation to your language
• Add you language to the i18n section of docs/theme.config.tsx and docs/next.config.js
• Make sure to translate the values (edit / feedback links, theme switch, toc etc.) in the docs/theme.config.tsx,

Translators

Project

API

Describe the feature you want to request

For SEO it's important to create a sitemap to inform the search engines about available sites.
Therefore a sitemap is essential for the api.

(Optional) Describe a solution for this feature

Use the sitemap_generator gem to generate the sitemap.

For the default_host use https://api.potterdb.com.
Please create the sitemaps only for the collections, e.g. /v1/characters and not for every /v1/characters/:slug.

You should also link the sitemap in robots.txt.

Project

Website (Potter DB Search)

Describe the feature you want to request

I want to add a page which consist of harry potter prominent Characters pictures displayed.

(Optional) Describe a solution for this feature

I can create a responsive image gallery with animation on images while scrolling

Project

Website (Potter DB Search)

Describe the feature you want to request

The API also gives data for Potions from the Harry Potter Universe.
Therefore there should be pages for potions on the website, too.

(Optional) Describe a solution for this feature

Create a page to list all potions (similar to the character list) and a general slug-based page for detailed information about a specific potions (such as here).
For the fetching of the data make sure to also create a new load_potions.js file similar to this one.

You also should link the potions page in the footer.

Make sure to have the same folder structure and layout as the other pages (characters and movies).

If you have any questions, feel free to leave a comment below.

Project

Website (Potter DB Search)

Bug description

When searching for some data with the Potter DB Search and clicking on some characters results to a 504 error.
Also seems to happen with some pages for potions and spells.

Expected Behavior

It should load the single character page without timing out.

Steps to reproduce

Search for Hedwig in the Character search and click onto to first card. Loading the detailed character info results into a 504: GATEWAY_TIMEOUT.

Screenshots

Logs

No response

Discussed in #172

^{Originally posted by danielschuster-muc October 1, 2022}

Project

Website (Potter DB Search)

Describe the feature you want to request

When you get to a page that is not found, you will see a very empty 404 page.

(Optional) Describe a solution for this feature

Edit the 404 page inspired by the image below.

The title of the page should be Have you seen this page?.
In the middle the image with Sirius and below a paragraph with Approach with extreme caution! To not attempt to use magic against this site!
There should also be a button to go back to the homepage.

Make sure to follow the style of other page, use MUI and proper credit the image of Sirius in the Attribution file.

Project

Website (Potter DB Search)

Describe the feature you want to request

Everyone has different code styles, therefore it would be useful to implement prettier and eslint to have a general code style for Potter DB.

(Optional) Describe a solution for this feature

Install prettier and eslint, configure it for next.js and for compatibility between those.
Options should be default, see here.
Additionally add a git hook to automatically format and lint the files on commiting.

Project

Website (Potter DB Search)

Describe the feature you want to request

Create Custom Error Pages (404/500) in a Harry Potter Style. If you don't know how to implement those pages, you can also show a screenshot of a possible layout for those pages.

(Optional) Describe a solution for this feature

No response

Discussed in #182

^{Originally posted by ahmedsilat44 October 3, 2022}

Project

Website (Potter DB Search)

Describe the feature you want to request

So while using the website. I think it would improve the experience if there was a navbar.

(Optional) Describe a solution for this feature

Add a hamburger menu which opens a dropdown where you can see also the information from the footer, e.g. General, Search and Information and their sub links.

Make sure to follow the style of the other pages on the Website and use MUI.

Project

Website (potterdb.com)

Describe the feature you want to request

Currently, there is a button that fetches more data. Instead, we can implement infinite scrolling functionality that fetches more data as the user scrolls.

Would you like to work on this issue?

Yes

Discussed in #172

^{Originally posted by danielschuster-muc October 1, 2022}

Project

Website (Potter DB Search)

Describe the feature you want to request

Similar to the current 404 page (see #202), the 500 error page (when an internal server error occurs) is also very empty at the moment.

(Optional) Describe a solution for this feature

Edit the 500 error page and include an image of Harry and Ron crashing in the The Whomping Willow.

As the title of the page write 500 - Internal Server Error and the subtitle Hm, looks like the server crashed. Please try again later or contact us by write a GitHub Issue if the problem persists.
There should also be a button / link to this Issue Tracker.

Make sure to follow the style of other page, use MUI and proper credit the image of the Whomping Willow you used in the Attribution file.

Project

Website (Potter DB Search)

Describe the feature you want to request

I realized that the DB currently has the main villain itself missing :)
https://potterdb.com/characters?q=voldemort
I could work on collecting the Wiki and contribute, thanks!

(Optional) Describe a solution for this feature

No response

Project

Website (potterdb.com)

Describe the ticket you want to create

In creating our new website it would be nice to have an improve navbar, which contains some important links.

It should contain:

• Logo (already there)
• Link to our documentation
• Link to our status page
• Hamburger menu, which links to the different DB search pages (e.g. characters, books, movies, etc.)

Make sure to make a branch from new-website.

If you have any questions, feel free to ping me. You can also send some pictures from current progress or make the PR as a draft.
Please the leave a note before starting, so I can assign you to this issue.

Acceptance Criteria

• Has all the required fields / links
• It is splitted in reasonable components
• The navbar is mobile-friendly

Additional Details

No response

Screenshots

No response

Logs

No response

Project

Website (Potter DB Search)

Bug description

The inputs align in a single line on mobile devices affecting UX.

Expected Behavior

Inputs to be aligned below each other for improved visibility, and better handling of by the user.

Steps to reproduce

Open homepage in mobile device.

Screenshots

No response

Logs

No response

Project

API (api.potterdb.com)

Describe the feature you want to request

Self-explanatory Swagger that would not necessarily replace but extend existing GraphQL and REST API documentation:

• https://docs.potterdb.com/apis/rest
• https://docs.potterdb.com/apis/graphql

(Optional) Describe a solution for this feature

No response

(Optional) Screenshots

No response

Project

Website (Potter DB Search)

Bug description

The sitemap link is broken under the footer

Expected Behavior

When click it should take me to the sitemap page

Steps to reproduce

No response

Screenshots

![DESCRIPTION](LINK.png)

Logs

No response

Project

Website (Potter DB Search)

Describe the feature you want to request

The current logo is very simple and I think it can be improved upon.

(Optional) Describe a solution for this feature

I can make a new and unique logo using Canva.

Project

API

Describe the feature you want to request

Currently the summaries of the movies in the API are very boring and lacking of content.

(Optional) Describe a solution for this feature

Write new, better and more meaningful summaries for each movie. The files for the movies can be found here.
Make sure to write own and not copied summaries, as I won't accept summaries copied from somewhere else.

Project

Website (potterdb.com)

Describe the ticket you want to create

Create the books index and show pages

Acceptance Criteria

• Add the book index and show page.
• Create skeleton animations that fit with the actual content.
• Make sure to split the content in useful components.
• Add metadata for SEO.
• Add /books link in Footer.

Additional Details

No response

Screenshots

No response

Logs

No response

Project

Website (potterdb.com)

Describe the feature you want to request

• Related to frontend.
• Font style and font size according to the style of the card.
• Font color related to the card color.
• Image fixed relative to the dimension of the card.
• Moving and glowing card effect.

(Optional) Describe a solution for this feature

• Not a good User interface of the cards.

(Optional) Screenshots

![DESCRIPTION](LINK.png)

Project

Website (Potter DB Search)

Bug description

Front-end is using https://potter-db-herokuapp.com/status to check API status.

Expected Behavior

Front-end is using https://potter-db-api.herokuapp.com/status to check API status.

Steps to reproduce

Just follow the steps in the frontend/README.md file.
When you visit http://localhost:3001 in browser, you'll see the 503 error.

Screenshots

Logs

No response

Project

Website (potterdb.com)

Bug description

I can help make the front end more attractive allowing new users to be able to learn more about api

Expected Behavior

• Mobile Optimization
• Better UI/UX and fonts

Steps to reproduce

No response

Screenshots

![DESCRIPTION](LINK.png)

Logs

No response

Project

Website (potterdb.com)

Describe the ticket you want to create

In building the new website (see new-website branch) we need your help.
This ticket is about creating the spells index (list/overview) and show (details) pages.

Get started

• Please add a short note below before starting with this ticket, so I can assign it to you.
• Fork this repo and make sure to branch up from new-website.
• Start implementing the features (see Acceptance Criteria).

You can get some inspiration by looking at the old spells page. But make sure to keep it in a similar style as the new character pages.

If you have any questions or concerns, feel free to ask below.

Acceptance Criteria

• Add a spell index and show page.
• Create skeleton animations that fit with the actual content.
• Make sure to split the content in useful components.
• Add metadata for SEO.
• Add /spells link in Footer.

Additional Details

https://github.com/danielschuster-muc/potter-db/tree/new-website/frontend/src/components/characters
https://github.com/danielschuster-muc/potter-db/tree/new-website/frontend/src/app/characters
https://beta.potterdb.com/characters

Screenshots

No response

Logs

No response

Project

API

Bug description

The list endpoints (/spells, /potions, etc.) only return the first 100 results

Expected Behavior

No response

Steps to reproduce

No response

Screenshots

No response

Logs

No response