praful932 / kitabe Goto Github PK

Describe the bug
The helpers.py file does not have clear docstrings for functions. Documentation of this would help developers have a clearer picture of the code.

To Reproduce
Steps to reproduce the behavior:

1. Check the helpers.py file

Expected behavior
The docstrings of the functions should be documented according tonumpy style guide.

Screenshots
Currently it only contains a docstring containing a short description of the function.

Additional context
For numpy style docstrings refer this.

Definition of Done
All functions are documented using numpy docstring and running this docstr-coverage mainapp/helpers.py command results in 100% coverage.

Is your feature request related to a problem? Please describe.
The options to sign up, logout, explore or other such options are available on the top of the home page and explore page, but when you are scrolling down and you want to use one of these options you have to scroll all the way to the top of the page Which is tidious.

Describe the solution you'd like
A very good solution to this problem will be a top button on the bottom right corners of the home and explore page. This button can have an upward arrow or top written on it and it will take you to the top of the page when clicked. The button can be customised and made attractive using CSS.

Are you willing to contribute to this issue?
Yes, I am a participant in GsSOC'21.

Describe alternatives you've considered
I thought of using a sticky navigation bar but personally I don't like that kind of navigation bar, it covers the contents and is irritating.

Describe the bug
Make migrations comment shows error when ran without making the mentioned changes in settings.py.
So in contributing.md we have to move the make migrations step after the step to make changes in settings.py

Are you willing to contribute to this issue? [Yes/No]
Yes, I am a GsSOC'21 participant.
Desktop (please complete the following information):

• OS: Windows
• Browser : Chrome

Is your feature request related to a problem? Please describe.
Yes it is a feature request from improvement of read me file !!

Describe the solution you'd like
I will like to add tech stacks used in this project with their logos this will make our project look much more attractive will like to work on this issue as soon as I get assigned !!

Are you willing to contribute to this issue? [Yes/No]
yes ( GSSOC21)

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
I will like to update the read me

Will look like this ( Example of my work )

Is your feature request related to a problem? Please describe.

No,its an additional feature.

Describe the solution you'd like

I would like to add more filters for sorting the books on the basis of languages, authors, likes, series or not and many more on the similar lines.

Are you willing to contribute to this issue?

Yes

I want to edit the Sign-up & Sign in form and add a preloader.

Is your feature request related to a problem? Please describe.
Navbar contain brand name as a simple text. Having a brand image instead of simple text would look better.

Describe the solution you'd like
Adding the logo as the brand-image.

Are you willing to contribute to this issue? [Yes/No]
Yes, I want to contribute to this issue as a part of GSSOC'21.

Additional context

• Before change:
  

• After change:
  

Currently the Page Displays Top Books from the Dataset.

Describe the bug
Book Summary of certain Books after searching are incomplete.

To Reproduce
Steps to reproduce the behavior:

1. Go to the Homepage
2. Click on the search bar
3. Type a Book Name
4. Let the Book Summary Load

Expected behavior
The book summary should be readable and complete.

Screenshots

Desktop (please complete the following information):

• OS: Windows 10
• Browser : Chrome
• Version 86

Smartphone (please complete the following information):

• Not applicable

Additional context
NA

Is your feature request related to a problem? Please describe.
Currently the number of components used to determine book embedding is 200. Since it seemed to work and the search takes a lot of time for us locally, We fixed the hyperparameter to that.

Describe the solution you'd like
Does a better hyperaparameter exist? Can we do a Randomized Search or a Grid Search to determine that, maybe even tune other parameters? Even after finding a better one with a lesser loss, does it produce a better output when the similarity metric is used?

Additional context
Refer the Embedding Notebook in The Notebook & Files Section for code. You can either Integrate Surprise with ScikitLearn Grid Search or use another package to determine embedding and do they perform well

Describe the bug
Clicking on Kitabe will direct you to the index page is not easily understood. Users are in a habit of using Home button. So to go to the home page they always look for the home button.

Expected behavior
A home button in the right where rest of the buttons are will be more user friendly.

Are you willing to contribute to this issue? [Yes/No]
Yes, I am a GsSOC'21 participant.

If one seems to be interested in a book by a particular writer, we suggest them more books by the same writer.

I'm an GSSoC'21 participant please assign this issue to me.

Describe the bug
Production Settings causing KeyError in some systems

To Reproduce
Steps to reproduce the behavior:

1. Follow Setting up Steps
2. Last step python manage.py runserver gives `KeyError

Expected behavior
The Project should have been run normally

Screenshots

Describe the bug
Allowed_hosts=['127.0.0.1'] doesn't work in some browsers. It shows an error to add 'localhost' in Allowed_hosts.

Expected behavior
I expected to see the pages but it showed errors.

Are you willing to contribute to this issue? [Yes/No]
Yes, I am a participant in GsSOC'21.
Desktop (please complete the following information):

• OS: Windows
• Browser :Chrome

Additional context
We just need to add "localhost" to the Allowed_hosts and then it works fine.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Are you willing to contribute to this issue? [Yes/No]

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The Book Title for some books overflows the text box which makes the page look messy and confusing.
Also, when you hover over the picture, it slightly enlarges which makes it look like a clickable element.

Describe the solution you'd like
A clear and concise description of what you want to happen.
The white background should be resized to fit the content in it. Also, change the css of the buttons to make the page more user-friendly by changing layout or adding features like hover.

Are you willing to contribute to this issue? [Yes/No]
I am a participant of GSSOC'21 and would love to work on this issue

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
we can make the lists under genre similar to list under the explore page.

Additional context
Add any other context or screenshots about the feature request here.

like the buttons here hide some of the text.

Whereas, the explore page has this layout.

Is your feature request related to a problem? Please describe.
A new page having a list of already read books by the user.

Describe the solution you'd like
I would like to create a new page which has a list of all the already rated books by the user which can be accessed through the navbar, the theme of the page would be consistent with the website.

Are you willing to contribute to this issue? Yes, I am willing to contribute to this issue as a participant in Gssoc'21.

Describe alternatives you've considered
None as of yet.

Additional context
As an avid reader myself I feel that having a page with books that have been already read by the user is an important feature.

Hi! I would like to add the following in contributing.md
Add the following -

1.Difference between GIT and GITHUB
2.How to clone,fork repository
3.How to create a branch and then use git push to push to repo
4.Create a PR
5.Squash commits in a single issue into one
6, Updating the forked and local repo as the updations are made in the upstream
I would lie to work on this as a part of GSSOC'21

The footer does not contains Contact information, mode of payment and other things hence it looks very dull. As a GSSOC'21 participant i would like to work on the issue.

Add Unit Tests for AJAX Views & User Model

Is your feature request related to a problem? Please describe.
There are cases when there is not enough books to recommend the user, In this cases currently next top books are taken up according to TF-IDF approach.

Describe the solution you'd like
A better approach would be to take in equally from TF-IDF also similar genre books. If the remaining books to be recommended are 4, 2 - TF-IDF & 2 - Similar genres book. Also take into account already rated & included books before adding those 2 similar genres book.

Concerning Code Line

Describe alternatives you've considered
If there is any other alternative you would like to suggest go ahead.

Additional context
Concerning tests should be written.

Describe the bug
The coverage of the file helpers.py is low 59%.

To Reproduce
Steps to reproduce the behavior:

1. coverage run manage.py test mainapp
2. coverage report

Expected behavior
Code coverage for the corresponding file should be atleast 90%

Screenshots

Additional context
To increase the coverage corresponding tests have to be written in tests.py.
To see the code which has not been covered by tests after running coverage report run coverage annotate and open the corresponding coverage file. For more details check out the docs.
If you are new to django testing check out this.

Definition of Done
Code coverage for helpers.py is atleast 90%

Describe the bug
The carousels used under 'Read Genre Wise' overflows beyond 3 (as indicated ). Also this way it becomes hard/tricky for the user to select a particular Genre (as they have to keep searching).

Also we can rescale the image below navbar, to redirect the attention to the 'Genres' section.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://kitabe-app.herokuapp.com/'
2. Scroll down to 'Read Genre Wise'
3. Click on "next" arrow under any carousel
4. See error

Expected behavior
Expected to show me a list of similar Genres.

Screenshots

Are you willing to contribute to this issue?
Yes
I have made a mock-up design here on how we can make the carousel part better :https://www.figma.com/file/quY3GKiD5RgWhsJAg2PKyE/Carousel-draft-Kitaabe?node-id=0%3A1
Being a book lover, I would love to work on this issue, as a GSSoC'21 participant.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
I feel the colour theme of the website can be made more vibrant/ cozy (to give modern day library vibes😄).
My design-mockup is just a suggestion. Feedback is welcome!
@maneprajakta @Praful932

Is your feature request related to a problem? Please describe.
A contact us page is a must for any site. How else are people going to get in touch with you. I think this an important feature that must be included.

Describe the solution you'd like
Hence, to solve the above problem. I would like to develop a contact us page for everyone using this site.

Are you willing to contribute to this issue? [Yes/No]
Yes.

Describe alternatives you've considered
If not a page, a contact us/get in touch popup could also suffice the need.

Additional context
Add any other context or screenshots about the feature request here.

Describe the bug
When you hover over any book displayed in the explore page, 2 buttons (More Details, Rate this book) appear below the book div. This causes all the divs under this block to be shifted downwards, which appears to be messy and confusing.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://kitabe-app.herokuapp.com/
2. Click on the explore button in the top right corner
3. Hover over any book and see how it changes when you unhover.

Expected behavior
We can keep the layout consistent and change the divs in the explore page so that they are similar to the book list appearing in any genre page. For example: https://kitabe-app.herokuapp.com/genre_books/Fantasy

Screenshots

The buttons that have appeared under the first book make the page look messy.

It could be made similar to the books in genre list

Are you willing to contribute to this issue?
Yes. I would like to contribute to this issue as a Gssoc'21 participant.

Desktop (please complete the following information):

• OS: Windows
• Browser: chrome
• Version: 89

Smartphone (please complete the following information):

• Device: Redmi K20
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Describe the bug
The navbar disappears as soon as we scroll down.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'home page'
2. Scroll down

Expected behavior
The navbar should be fixed at the top even when the user scrolls down the page.

Screenshots
If applicable, add screenshots to help explain your problem.

Are you willing to contribute to this issue? [Yes]

Desktop (please complete the following information):

• OS: Windows
• Browser: chrome
• Version:

Additional context
All the changes made should be responsive.

Describe the bug
Image formats like JPEG 2000, JPEG XR, and WebP often provide better compression than PNG or JPEG, which means faster downloads and less data consumption. Kitabe mostly uses jpg and png image formats which affect the website's overall performance.

Expected behavior
Faster Reloads

Are you willing to contribute to this issue? [Yes]
I am a GSSOC participant.

Is your feature request related to a problem? Please describe.

No, it's an additional feature.

Describe the solution you'd like

I would like to propose a solution where readers can like the book of their taste and also avail the buying feature that will redirect them to the e-commerce sites.

Are you willing to contribute to this issue?

Yes, I am willing to contribute.

Hi @Praful932 and @maneprajakta
I went through your project and I really liked it a lot.
The idea of good books being recommended to is fascinating to a bookworm like me.
Here are some suggestions:

1. The logo on the left side of the home screen is smaller in size.
2. The images you are using are of quite high quality and it seems to hamper the loading time of the website. Try using a image-size compressor like this (sorry I have no idea about the python package with similar function 😅).
3. The color palette for the website is a bit dull. Try adding some contrasting and fresh colors. Refer this.

Regards,
Abhishek

Is your feature request related to a problem? Please describe.
Better UI for signup page.

Describe the solution you'd like
Signup page UI ,Signup Form can be updated with latest styling design using responsive frontend framework - "Materialize"

Are you willing to contribute to this issue? [Yes/No]
Yes, I would like to contribute on this issue being part of gssoc'21

Additional Context
Everything should be responsive.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Are you willing to contribute to this issue? [Yes/No]

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Google authentication would allow the users to sign up by just a single click, instead of manually signing up and logging in. I'd love to add this feature.

Is your feature request related to a problem?
The existing Login Form has minimal design which may lead to a bad impact for users.

Describe the solution you'd like
I would like to redesign the login page with material bootstrap as a frontend work.

Are you willing to contribute to this issue? [Yes/No]
Yes, I am ready to contribute in the same issue. I am a participant in GsSOC'21
Please assign it to me.

Thank You 🙏

Existing Login Page

Is your feature request related to a problem? Please describe.
Wishlist or a save for later feature where one can save their favorite books for later.
Ex: When a person is randomly browsing through the website and comes across a book of his/her interest but is already preoccupied by other things and wants to keep it for later can use this feature to save the book in his/her "to read list".

Describe the solution you'd like
Just like web browsers have bookmark option, e-commerce websites have wish list option to have a collection of their favorite stuffs, a similar feature must be added to the Kitabe to save people's time of looking up for same book again and again.

Are you willing to contribute to this issue?
Yes, I am willing to contribute to this issue as a participant in Gssoc'21.

Describe alternatives you've considered
I thought of adding a "recently viewed" section.

Additional context
As a avid book reader i always look up for new books but sometimes due to my schedule i can't read them all. Having a collection of my favorite to-read books in one section would be very helpful.

The project looks amazing and the ReadMe file is indeed quite catchy and attractive. I did check the codes and saw that they need a few refinements and improvements. However, I also did observe that you have open issues for improvements already suggested. Just a friendly tip: Try and use individually worked content for feedbacks rather than co-authored work.

Replace the current approach of Count Vectorizer with Tf-idf.

Describe the bug
The navigation bar of the site should be full of the name of the venture, however, the ne of the venture itself is extremely small in size and has not been aligned properly, the color palette of the site can be more vibrant and attractive and the fonts can be changed too. I feel in doing so, the site will attract traffic and be a successful one at it.

To Reproduce
Steps to reproduce the behavior:

1. Go to "https://kitabe-app.herokuapp.com/"
2. Scroll down to the very end
3. Made me realize the site can have a vibrant color palette and the font sizes can also be adjusted to the desired sizes.

Expected behavior
Learning that this is a site about books, I feel the content can be edited to a more readable text and a formal one at that too.
Screenshots

Are you willing to contribute to this issue?
YES

Desktop (please complete the following information):

• OS: Windows
• Browser Chrome
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
All changes made should be responsive.

There should be visual feedback or validation for the user after a book has been rated.

Is your feature request related to a problem? Please describe.
A switchable Dark Mode

Describe the solution you'd like

• Wireframe & Mockup Design
• Code Implementation

Describe alternatives you've considered
If there is any other alternative you would like to suggest go ahead.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Are you willing to contribute to this issue? [Yes/No]

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

I want to add the profile page of the reader as a participant of GSSOC'21. Please assign me this one.

Hey! I loved your project. The idea of using ratings was good too. But wont the existing books over shadow the recently published books due to fewer ratings. For example if I liked a particular book, I give it a 5-star rating but because there is only one review it wont be suggested to more people right? Because other books that are good would be having 5 stars and more number of reviews too. Not sure but if we use feature extraction from ML you can make the system even more accurate. Just a suggestion not an expert.

Hi I really liked the idea of the book recommendation system and project that you have built so far. I also visited your project website. It looks really nice.
Some suggestion for improvement:

1. I notice that you have used a lot of carousels, well it looks good at first but it's difficult to use at least for me when I was exploring your explore page and your home page genre session. I would like it more if new books are added as I scroll down on the explore page. For genre sessions I would recommend showing it all in grid view in your home page.
2. Color scheme can be improved. There are many website that you can use like coolors.co or colorhunt.co.
3. For some book cards where author name and book name are long they overlap the rate this button and more details button. You can tackle this by defining a fix size for author name and book name sessions for each bookcard and crop the rest of part if it does not fit in the defined size replacing it with ... .

Regards,
Sudhir

Describe the bug
The command given for activating the environment (in CONTRIBUTING.MD file) is not working on windows platform. Instead the given commands work on Linux/Unix machines. I got error while running this command as "source is not recognized as internal or external command".

To Reproduce
I would like add command which executes on windows system.

Screenshots

Are you willing to contribute to this issue? [Yes/No]
Yes
Desktop (please complete the following information):

• OS: Windows

Popular among us Book card
The current book card does not put a limit on the book title and book author text displayed.
so, when the book title name, author name exceed the line limit that can be displayed on the card it leads to overflow and also overlaps with the buttons.

To Reproduce
Steps to reproduce the behavior :

1. Go to 'home page'
2. Scroll down to the 'popular among us section'
3. See book cards

Expected behavior
Author name and Book title should fix in the card without overflow and overlap.

Screenshots

Are you willing to contribute to this issue? [Yes/No]
Yes

Desktop (please complete the following information):

• OS: Ubuntu
• Browser:Chrome
• Version :86.0.4240.198 (Official Build)

Is your feature request related to a problem? Please describe.
Viewing all the genres through the carousel is a bit difficult.

Describe the solution you'd like
Adding a dropdown list of genres in the navbar will make it easier, to get a quick view.

Are you willing to contribute to this issue? [Yes/No]
Yes

Additional context
https://immense-cove-79525.herokuapp.com/ -- similar to the services dropdownlist

Is your feature request related to a problem? Please describe.
Currently there's no way to rate a book after searching it

Describe the solution you'd like
I'm able to rate through the modal after I search for a book

Additional context
The stars that are currently displayed is the average rating. Changes are made and all tests pass. If user is not logged in, and the book is rated he/she should be redirected to login page.

Describe the bug
The coverage of the file views.py is low 60%.

To Reproduce
Steps to reproduce the behavior:

1. coverage run manage.py test mainapp
2. coverage report

Expected behavior
Code coverage for the corresponding file should be atleast 90%

Screenshots

Additional context
To increase the coverage corresponding tests have to be written in tests.py.
To see the code which has not been covered by tests after running coverage report run coverage annotate and open the corresponding coverage file. For more details check out the docs.
If you are new to django testing check out this.

Definition of Done
Code coverage for views.py is atleast 90%

Is your feature request related to a problem? Please describe.
Since the project is hosted on the heroku free tier, it takes some time to load, It would be nice to have a preloader.

Describe the solution you'd like
Before the homepage is loaded, there should be a loading animation whose design matches with the theme of the website. It should load only once(using cookies) when it enters through the domain name, and not everytime the user goes to the homepage.

• First a mockup design should be shown
• Then after approval code changes should be made

Describe alternatives you've considered
Open to alternatives!

Additional context
The preloader should be responsive and bug-free.

Describe the bug
There are certain frontend bug fixes especially the Rate this book button after the last patch. All bugs are after a user signs in.

Screenshots

1. Homepage - Popular Among Users Section (Improper Button Size and Alignment)
   
2. Your Read Section (Improper Size, Alignment and Rating Validation)
   

Expected behavior

1. All buttons should be fixed as when user is not logged in
   
2. For 3. Validation should be added after a book is rated, similar to below
   

Definition of Done
All sub-tasks are done and pass tests

Describe the bug
Debug is set as true in settings.py. This may cause security vulnerabilities.

Describe the solution you'd like
set DEBUG = False

Are you willing to contribute to this issue? [Yes/No]
Yes, I want to contribute to this issue as a part of GSSOC'21.

Desktop (please complete the following information):

• OS: Windows
• Browser : Chrome

Screenshots

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Are you willing to contribute to this issue? [Yes/No]

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.