pb-demo.mp4
People publish a lot of fascinating research out to the world, yet the tools to consume this research are quite primitive. It is also really hard to understand the research papers.
PaperBrain is the go-to platform for accessing and understanding research papers. We provide a fascinating interface for users to search for papers and return a list of papers with their abstracts and a direct pdf link in a prettified format.
Since research papers are generally difficult to understand, we have added a explain paper feature leveraging a GPT-3 model provided by Open AI. Users can simply copy-paste an excerpt and our primed model will translate it into an easy and understandable form.
PaperBrain also allows you to upload your own papers and interact with the in-built GPT assistant to better streamline your research understanding process.
| Tech | Link |
|---|---|
| Front End | Next.js |
| Back End | Flask |
| Explain Paper Bot | GPT-3 |
| Styles | Tailwind CSS |
| Storage Bucket | Firebase |
| Hosting | Vercel |
| Authentication | Auth0 |
| Name | GitHub |
|---|
Nawed Ali | nawed2611
Mohd Arshad | mdarshad1000
Saad Anzar | SaadAnzar
ggit clone https://github.com/<your_github_username>/paperbrain.git
cd paperbrain
npm install
npm run dev
Step 1: Fork the repo and Go to your Git terminal and clone it on your machine.
git clone https://github.com/<your_github_username>/paperbrain.git
cd paperbrain
Step 2: Add an upstream link to the main branch in your cloned repo
git remote add upstream https://github.com/<your_github_username>/paperbrain.git
Step 3: Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
git pull upstream main
Step 4: Create your feature branch (This is a necessary step, so don't skip it)
git checkout -b <branch-name>
Step 5: Track and stage your changes.
git status
Step 6: Add all the required changes
git add .
Step 7: Commit all the changes (Write commit message as "Small Message")
git commit -m "<your-commit-message>"
Step 8: Push the changes for review
git push origin <branch-name>
Step 9: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)
##STEPS TO SIGNIN TO paperbrain APP
Step1:create your auth0 account
`https://auth0.com/`Step2:Create a Regular Web Application in the Auth0 Dashboard.
Step3: configure the following URLs for your application under the "Application URIs" section of the "Settings" page: Allowed Callback URLs: http://localhost:3000/api/auth/callback Allowed Logout URLs: http://localhost:3000/
Step4:In your main project directory install the auth0 package through npm
`npm install @auth0/nextjs-auth0`Step5:create a .env.local file under your root project directory that defines the necessary Auth0 configuration values as follows: # A long, secret value used to encrypt the session cookie AUTH0_SECRET='LONG_RANDOM_VALUE' # The base url of your application AUTH0_BASE_URL='http://localhost:3000' # The url of your Auth0 tenant domain AUTH0_ISSUER_BASE_URL='https://YOUR_AUTH0_DOMAIN.auth0.com' # Your Auth0 application's Client ID AUTH0_CLIENT_ID='YOUR_AUTH0_CLIENT_ID' # Your Auth0 application's Client Secret AUTH0_CLIENT_SECRET='YOUR_AUTH0_CLIENT_SECRET'
type the below code in terminal to get the large random value node -e "console.log(crypto.randomBytes(32).toString('hex'))"
Step6:Now try signing, It will work.