researchhub / researchhub-web

🚀 Accelerating Science - researchhub.com Next.js web app

The ResearchHub Next.js Web App

 

Our Mission

Our mission is to accelerate the pace of scientific research 🚀

We believe that by empowering scientists to independently fund, create, and publish academic content we can revolutionize the speed at which new knowledge is created and transformed into life-changing products.

Important Links 👀

💡 Got an idea or request? Open issue on Github.
🐛 Found a bug? Report it here.
➕ Want to contribute to this project? Introduce yourself in our Discord community
🔨 See what we are working on
📰 Read the ResearchCoin White Paper

Setup

1. Run cp .env.development.example .env.development
2. nvm install 20.11.1 (installing nvm)
3. nvm use 20.11.1
4. yarn install (installing yarn)
5. yarn run dev
6. You will also need to install the backend app for the project to run

macOS

Executing yarn install on macOS may display some gyp errors associated with the canvas native dependency. To fix these errors, install the following packages using Homebrew:

brew install pango pkg-config

Contributing to the codebase

1. Fork this repo and then clone it to your local env
2. Create a new branch

git checkout -b MY_BRANCH_NAME

3. Submit a pull request against master branch of this repository

researchhub-web's Issues

Author/profile page

Create profile page for users.

• Comments tab
• Authored Papers
• User Profile without an account ( used for authors who are not in the system yet)
• User Profile with accounts ( for all users who have an account. Displays more information)

Start React project

How does this affect users?

n/a

Testing

1. $ yarn start

Notes

n/a

Create api call to search papers by name

Create api call to get authors in paper upload

Search Author Container height needs to be adjusted depending on the results

Paper Upload Flow End To End

Paper upload flow needs to be end to end, from uploading a PDF to adding paper metadata to seeing it live on the site

Create discussions tab

Create the discussions tab for a paper

Submit button needs to be removed from Upload Paper Flow

The submit button in the bar needs to be removed

Create style theme library

Make app SEO compatible

Testing

1. Test it with https://support.google.com/webmasters/answer/9012289

TODO: Determine if we need SSR

Restrict email login to .edu or google oauth

How does this affect users?

Only allow users with .edu email

Testing

1. Go to /login or /signup
2. Enter an email that is not .edu
3. Notice it doesn't send a token
4. Enter a .edu email
5. Notice it sends a token!

Create api call to post paper upload

Type confirm that file dropped in DragNDrop is a PDF

Make discussion thread actions clickable

Instead of making the entire thread card on the discussion tab navigate to the thread page, only make the timestamp, title, read button, and comments button navigate to the thread's page.

The author should go to the author's profile.
The share button should have its own functionality, TBD.
The vote widget has its own functionality.

Show comment immediately after submission

When we submit a comment, we should immediately see it in the list of comments.

Also when we submit the comment, the comment box should reset back to initial state.

Voting Component

Create the voting component

• Display current rating
• Upvote functionality
• Downvote functionality

Add api lib

How does this affect users?

n/a

Testing

n/a

Upload paper flow, add discussion

Create section to add discussion to paper being uploaded

• Title input
• Post input

Create paper page tabs

Create tabbing functionality for papers

Discussion page not getting Discussion / Comments

Something broke in the newer versions of this page. The comments / discussions are not being rendered properly. Not sure if they're not grabbed from the backend or the frontend isn't rendering it properly.

Edit history tab

Create edit history tab to view all edits

After creation of user, we need to create an author

Add testing framework

How does this affect users?

n/a

Testing

1. $ yarn run test

Notes

n/a

Paper Page Header

Create the header for the paper page.

• Title
• Description/Summary
• Author
• Tags
• Date
• Actions

ResearchHub Logo / Icon use assets

In the #design channel on Slack, Irinya has given us assets

Infinite Scroll Discussion Threads + Infinite Scroll comments

• Discussion Thread Infinite Scroll
• Comments Infinite Scroll

Auto-run tests before push

How does this affect users?

n/a

Testing

1. Write a passing cypress test
2. Commit and push the change
3. Notice cypress tests run and the change gets pushed
4. Write a failing cypress test
5. Repeat 2
6. Notice test fails and changes don't get pushed

Notes

n/a

Full paper tab

Create the tab where users can read the full research paper

• Display research paper for users to read

Navigating to paper that doesn't exist should 404

Repro

1. Go to a paper with an id that doesn't exist like paper/15124

Expected

Going to a paper page that doesn't exist on the backend returns 404 on client.

Observed

Produces an error

Invite user modal

Create the invite user modal from profile page

Create summary tab

Create the summary tab with user editing functionality.

• Grab sections of Summary from backend
• Add functionality for editing information
• Add functionality to display edit history
• Add functionality to revert changes

Edit Summary Metadata

The summary page metadata needs to be editable.

This includes all the metadata from the paper upload -- authors, publish date, title, and short descriptor.

Add new author modal

Create the add new author modal when adding authors that aren't in our system yet.

• Name Inputs
• University input
• Email input
• Social media links

Citations tab

Create tab to display the things that the paper cited, as well as papers that cited the current paper.

• citations
• cited by
• citation graph

Upload paper flow, add summary

Create section to add summary to paper being uploaded

Use same summary component as #9 without the extra functionality

Upload Paper Flow Skip for now button does not work

Skip For Now button does not work

Publish Date should not be required

Publish date should not be a required field

Create hubs page

Create hubs page

• display papers in hub
• sort/filter
• search
• locked hub page
• create hub page to view all hubs

Summary not submittable

We need the summary to be submittable.

Currently the summary flow does not get the summary from the backend, and then it also does not submit.

Add number of comments to discussion thread page

Upload Paper Flow Needs Go to Top

Once we move from step to step, we need to go back to the top of the page

Currently we land on this after moving to the next step:

Add redux and redux logger

How does this affect users?

n/a

Testing

1. $ yarn start
2. Notice redux store in local storage

Notes

n/a

Create google sign up form

How does this affect users?

See sign up with google

Testing

1. Go to /
2. Click signup with google
3. Login to google
4. Notice you are logged in

Notes

n/a

Upload paper flow main info section

Create the main info input section for the upload flow

• Upload/link paper
• Add authors
• Add paper info (publication date, hubs, paper type)

Search Authors not working

Can't tag an author that exists. What's the search searching? It should be searching email, first name, last name.

This may not be implemented yet

Create formatting for paper page and top nav bar

create the formatting for paper page (reusuable formatting for other pages) and the top nav bar

Paper search modal

Create modal to search for papers

• Search
• Display matches
• Button to upload different paper

Style discussion replies

Write post request for discussion thread replies

Testing

1. Go to a discussion thread page
2. Click reply
3. Enter text and click submit
4. Notice that a loader appears
5. Notice that the reply appears if the message is sent successfully
6. Notice that a notification appears if the message is not sent successfully

Discussion view

Create the discussion view thread.

• Discussion Post
• Thread functionality
• Commenting
• Replies