rchtgpt / summit

Read less. Learn more.

tl;dr of my life

• currently in college studying computer science, math, and linguistics
• appreciates design (don't open this link)
• doing research things at the TID lab

summit's Issues

Feat: Randomly generated summarized blog posts

Summary

To keep our dashboard more interactive, we should randomly fetch medium blogposts, summarize them, and display it on our website so that users can have a quick glance at a lot of stuff.

Working

We can do this using the API by posting random usernames to it.

Expected behaviour

A card grid or possibly a masonry layout to display them below the input form.

Add Documentation ✨

Is your feature request related to a problem? Please describe.
Yes. I would like to add Documentation features along with optimizing the README further.

Describe the solution you'd like
I wish to make the following changes:

• Add a separate page for Project Installation
• Add some Documentation for the work on the Frontend
• Add Documentation about NLTK and Summarization
• Add a Backend Doc explaining the Endpoints.

No README.md

The project must have a readme to ensure that contributors understand it's purpose and are able to work efficiently!

Add a navigation bar

Summary

A navigation bar on top with our cute little logo

Logo design

Expected behaviour

A react-bootstrap Navigation bar on top with the above logo on the left side of it with our primary color #343A3F as its bg.

Add Github Corners

Is your feature request related to a problem? Please describe.
If someone randomly comes across our platform, they won't be able to find our source code. And that stops us from being truly open-source.

Describe the solution you'd like
We should use React Github Corner on our website

Describe alternatives you've considered
We could potentially add a footer with our source code but IMO Github Corner would look more sleek.

Image

It will look like this on the top right corner!

Null image checker

Summary

Not all medium blog posts have thumbnails and therefore we need to add a check if an image exists or not, before displaying it on the frontend because it is creating chaos on the page.

Steps to reproduce

Refresh the page multiple times until you see a blog post with no image and weird dimensions

Expected behaviour

We should instead display the Medium logo as those post thumbnails.

Observed behaviour

Blog posts without thumbnail images will be displayed in the form of a stretched card with no image (obviously).

Fix conditional rendering of components

Describe the bug
Currently, all the blogs are rendered as cards even if users summarize blogs of their choice. There isn't a need to show the other blogs at that time.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mh.tech
2. Paste a valid Medium post URL and Click on Submit
3. Scroll down
4. You will find the other blogs being rendered there

Expected behavior
The other blogs should disappear when the user summarizes a particular blog

Screenshots

Desktop (please complete the following information):

• OS: Linux
• Browser Chrome

Feat: Summarize blog based on the input

Summary

We should give our users the option to input a medium story URL and get its summarised version as the output.

I think it would be a pretty cool thing to have along with the randomly generated summarized blog posts because it gives the user more control over our service.

Validate link of randomly generated medium articles

Describe the bug
If the medium article is not in the correct format (medium.com/@username/@postid) then the user doesn't get any message from the app to put it in the correct format.

To Reproduce
Steps to reproduce the behavior:

1. Go to www.summit-mlh.tech
2. Click on any of the medium link
3. See an error

Expected behavior
The user should get a message which shows the correct format of the link.

Desktop (please complete the following information):

• OS: Linux
• Browser: Chrome

Update the README because of reconsideration of Idea

Summary

As we decided to go ahead with a relatively different project idea, we need to modify our Github README according to it. (And lessen the number of emojis lol.)

Add Code of Conduct

Considering that we are building an OSS, having a Code of Conduct is really important to keep a well-rounded atmosphere in our community.

Summary length option

Is your feature request related to a problem? Please describe.
Sometimes, people want to choose if their summary should be short, medium, or long.

Describe the solution you'd like
It would be great if the user gets the option to choose the length of the output in terms of short, medium, long summary after entering the input URL of the blog.

Describe alternatives you've considered
We could take in a specified amount of characters or words but it will only make it difficult for the users.

Incorrect output card heading status checker

Describe the bug
The heading of the output card doesn't update because of an incorrect conditional statement.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mlh.vercel.app/
2. Enter a link of the format https://medium.com/@<username>/<post-id>
3. Click Submit
4. The summarized data will appear but the heading of the blog won't be displayed. It will just say "heading".

Expected behavior
The correct Blog title should be displayed in the heading.

Screenshots

Desktop:

• OS: MacOS
• Browser: Brave
• Version: Catalina 10.15.7

Add an Input URL Validator

Describe the bug
If the user enters a link of the wrong format, our website tries to process it but doesn't give an error message when it fails.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mlh.vercel.app/
2. Enter a link which is not of the format https://medium.com/@<username>/<post-id>
3. Click Submit
4. Nothing will change

Expected behavior
An appropriate error message should be displayed telling the user that the link entered is incorrect.

Desktop (please complete the following information):

• OS: MacOS
• Browser: Brave
• Version: Catalina 10.15.7

Add Contribution Guidlines

To make it easier for the contributors to be able to make meaningful additions/enhancements to the project, it's advisable to have a set of guidelines and a detailed procedure regarding the same.

Add code for the summarizer

Summary

Add the model that performs summarization on the text.

Expected behaviour

When called through an API, the model will take in the text, process it and then return a summarized text.

Show summary of random blogs on the dashboard

Is your feature request related to a problem? Please describe.
Yes, users should be able to see the summary of the randomly generated blogs

Describe the solution you'd like
When the user clicks on the post, he/she should be able to see the summary of that post
It is even better to provide the user with an option to select the summary length

Null checker in output card

Describe the bug
Before taking the input from the user, the output card is displayed with no text and no heading.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-git-medium-scraper.dotrachit.vercel.app/
2. DO NOT input anything
3. Look at the card below the input form

Expected behavior
A clear and concise description of what you expected to happen.
It should show messages like - "Heading" and "This is where your summarized text will be displayed"

Desktop (please complete the following information):

• OS: MacOS
• Browser: Brave
• Version: Catalina 10.15.7

Network error on hosted platform

Describe the bug
The hosted website doesn't process the entered URL because of a network error. However, it does work on the localhost.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mlh.vercel.app/.
2. Enter a URL in the input form.
3. Click on Submit.
4. Open the console to see the error.

Expected behavior
The hosted website should process the URL just like it does on the localhost.

Screenshots

Desktop:

• OS: MacOS
• Browser: Brave
• Version: Catalina 10.15.7

Log:

Mixed Content: The page at '<URL>' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint '<URL>'. This request has been blocked; the content must be served over HTTPS.
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.
(anonymous) @ xhr.js:177
e.exports @ xhr.js:13
e.exports @ dispatchRequest.js:50
Promise.then (async)
s.request @ Axios.js:61
r.forEach.s.<computed> @ Axios.js:87
(anonymous) @ bind.js:9
(anonymous) @ summarizer.js:42
Promise.then (async)
onSubmit @ summarizer.js:27
Ve @ react-dom.production.min.js:52
Qe @ react-dom.production.min.js:52
(anonymous) @ react-dom.production.min.js:53
Er @ react-dom.production.min.js:100
Or @ react-dom.production.min.js:101
(anonymous) @ react-dom.production.min.js:113
Ye @ react-dom.production.min.js:292
(anonymous) @ react-dom.production.min.js:50
Dr @ react-dom.production.min.js:105
Jt @ react-dom.production.min.js:75
Xt @ react-dom.production.min.js:74
t.unstable_runWithPriority @ scheduler.production.min.js:18
Va @ react-dom.production.min.js:122
Re @ react-dom.production.min.js:292
Zt @ react-dom.production.min.js:73
xhr.js:177 Mixed Content: The page at 'https://summit-mlh.vercel.app/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://mlh-summarizer.herokuapp.com/'. This request has been blocked; the content must be served over HTTPS.

Check original blog in the output card doesn't work

Describe the bug
The check original blog button doesn't work.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mlh.vercel.app/
2. Enter a link of the format https://medium.com/@<username>/<post-id>
3. Click Submit
4. The summarized data will appear but the Check original blog button won't work.

Expected behavior
Ideally, it should redirect us to the originally inputted blog link.

Screenshots

Desktop:

• OS: MacOS
• Browser: Brave
• Version: Catalina 10.15.7

Additional detail

• It should be hidden until the submit button is clicked.

Add Contributor Guidelines

A separate contributors.md can help new contributors set up the project easily on their local machine.

CORS Error on API Call

Describe the bug
On calling the summarizer API, a CORS error arises that blocks the request.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://summit-mlh.vercel.app/
2. Paste a valid medium article link
3. Click on Submit
4. Open up Console (right-click -> inspect -> console)
5. See error

Expected behavior
Upon clicking on Submit, the summarized text should pop up in the box below the same.

Screenshots

Desktop (please complete the following information):

• OS: Linux
• Browser: Chrome

API for Summarizer

Summary

Wrap the model in an API to be able to access it from the frontend

Expected behaviour

API call made from the frontend triggers the model to summarize the text and return the summarized text.

Add Issue and PR templates

Issue and PR templates make it easier for project managers to understand stuff. It also ensures that new contributors don't leave any important question unanswered while creating an issue or a PR.