Automatic Reviewer Assignment

ML Model to assign reviewers to your paper automatically!

Backend

Setup

It is recommended to use a virtual environment to set up the project. You can use either venv or miniconda to create the virtual environment. Once the virtual environment is created, install the requirements using the following commands:

By venv:
python3 -m venv venv
source venv/bin/activate

By conda:
conda create -n <env_name> python=3.10 # specify environment name and python version
conda activate <env_name>
pip install -r requirements.txt

Some users might face a problem with the installation of the requirements (especially psycopg-2). Please refer to this issue to solve the problem.

For the Postgres Database:

Install Postgres on your system, follow the instructions here.

Create a user named postgres with password postgres in the postgres terminal. In Ubuntu, this terminal can be accessed by typing sudo -su postgres psql in the terminal.

Create a database named nfp in postgres.

Make a copy of the .env.example file and rename it to .env.

If there is PG Admin installed in the system, it will be easy to administer and monitor the data using the platform.

Run the development server:

uvicorn main:app --reload to run the website

Frontend:

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

We start with the pages/index.js. The page auto-updates as you edit the file.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

We use Tailwind CSS for styling. The styles directory contains the global styles and the tailwind.config.js file contains the configuration for Tailwind CSS.

Workflow

The workflow for the user interface can be understood as:

• The user enters the website and is greeted with the home page.
• The user can then log into their account or create a new account.
• The user can then upload a paper (pdf) or enter the text of the abstract after which the user can search for authors, journals or articles related to the particular abstract.
• The user can then view the results of the search and select the authors, journals or articles that they want.