(Paperpilot) Research papers recommendations website Application

A next-js research website for timely and efficient delivery of research resources.

---

Features

• User recommendations and preferences management
• Diverse research resources API
• Advanced search functionality
• Email delivery of user research recommendations
• Clean user interface for easy interactivity
• Dark and light mode

visit live site here

Figma design

Design

Screenshots

---

How to use

Download

Download the zip file and unzip into your computer.

or

Clone this repository

To clone and run this application, you'll need git and npm installed on your computer Download Git

open up your terminal and clone this repository

git clone https://github.com/abel-otegbola/Paperpilot

open the folder

cd Paperpilot

create environment variables

• NEXTAUTH_SECRET (check here to learn more)
• NEXT_PUBLIC_SPRINGER_URL (Use http for local and https inpproduction)
• NEXT_PUBLIC_SPRINGER_API_KEY (Key to connect with the api... Learnmore)
• NEXT_PUBLIC_CORE_API_KEY (Key to connect with the api... Learnmore)
• NEXT_PUBLIC_IEEE_API_KEY (Key to connect with the api... Learnmore)
• NEXT_PUBLIC_MAIL_USER (Mailing account for sending emails)
• NEXT_PUBLIC_MAIL_PASSWORD (Mailing account password for sending emails)
• GITHUB_ID (For github authentication... learn more)
• GITHUB_SECRET (For github authentication... learn more)
• GOOGLE_ID (For google authentication... learn more)
• GOOGLE_SECRET (For google authentication... learn more)
• MONGODB_URI (Database comnection address... learn more)

Install the dependencies by running

npm install

Once installed, run

npm start

Project Structure

Here is a breakdown of the project structure:

├── node_modules/
├── public/
│   ├── pictures go here
├── src/
│   ├── App.jsx
│   ├── index.jsx
│   ├── styles/
|   |   ├── //styles go here
|   |   ├── App.css
│   |   ├── index.css
|   ├── pages/
|   |   ├── api/
|   |   |   ├── auth/
|   |   |   |   ├── next-auth configs go here
|   |   |   ├── apis go here
|   ├── components/
│   |   ├── //components go here
|   ├── database/
│   |   ├── connection.js // mongodb connection
|   ├── models/
│   |   ├── Schema // mongodb schemas
|   ├── utils/
│   |   ├── //utils go here
│   └── 
├── .gitignore
|── .eslintrc.json
|── tailwind.config.js
|── postcss.config.js
|── jsconfig.json
├── package.json
|── package-lock.json
├── README.md
├── next.config.js

• node_modules: contains all the project dependencies.
• public: contains any other static assets that will be served by the development server or included in the production build.
• src: contains the application code, including the entry point (main.jsx), the root component (App.jsx), and any other components or styles.
• .eslintrc.json: contains configuration options for ESLint.
• .gitignore: specifies files and directories that should be ignored by Git.
• package.json: contains project metadata and specifies dependencies and scripts.
• README.md: contains project documentation.
• next.config.js: contains configuration options for Nextjs.
• tailwind.config.js: contains configuration options for Tailwind-css.

credits

• Tailwind-css
• Semantic scholar
• Springer API
• Next-js

You may also like

Check out my awesome Mailme - endpoint generator website app built with Next-js