Team members:

• Xinyu (Diane) Hu - xh112
• Yichen Qian - yq82
• Zhensheng Xie - zx93
• Angikar Ghosal - ag520

Project chosen: semi-standard project

Our team chooses to do a “semi-standard” course project: a researcher club application based on databases containing published scholarly papers (paper title, author, abstract, affiliation, year, etc). On our application, users can “shop” papers they are interested in. The goal of our application is to help researchers efficiently access useful papers.

Team name: Crouching Tiger Hidden Dragons

Github repository: https://github.com/halfmoontonight/CS516-project

To run the project:

• Method 1: Download and unzip the file downloaded from https://lfs.aminer.cn/lab-datasets/citation/citation-network1.zip to get outputacm.txt. Go to folder db/data and run reformat_data.py to produce papers.csv, authorship.csv, citation.csv and abstract.csv. Make sure your reformat_data.py and outputacm.txt are in the same folder. Note: because these csv files are too large, we restrict uploading it to github.

• Method 2: Alternatively, you can go to our Google drive and downloaded the processed csv files in .7z zipped format. Google drive link: https://drive.google.com/drive/folders/1urSbgX54K9G9jF7Q9EzEXvPL9gbXis4n?usp=sharing Sign-in required

1. If you are using MacOS, switch your shell to bash ($chsh -s /bin/bash)

2. Make sure you have installed python3, pip3, psql

3. psql user role and password setting

# set a database role of <<username>
# make the username as same as your account on your host machine
$ sudo -u postgres createuser <<username>>

# give the user a super permission
$ sudo -u postgres psql -c "ALTER ROLE <<username>> WITH SUPERUSER;"

# make sure the username is bind with password
$ sudo -u postgres psql -c "ALTER ROLE <<username>> WITH PASSWORD '<<password>>';"

4. Run install.sh If you are using windows, install WSL and execute $./install.sh

If you are using MacOs, tweak your install.sh as follows and then execute $./install.sh

#!/bin/bash
 
brew install coreutils
# brew install python3
pip3 install virtualenv
brew install gsed
# brew install postgresql
 
echo "You may need to tweak .flashenv and db/setup.sh manually"
# sudo apt-get -qq coreutils
mypath=`realpath $0`
mybase=`dirname $mypath`
user=`whoami`
echo "Assume your database user name is: $user"
read -p "Enter database password and press [ENTER]: " dbpasswd
 
secret=`LC_ALL=C tr -dc 'a-z0-9-_' < /dev/urandom | head -c50`
cd $mybase
cp -f flaskenv-template.env .flaskenv
gsed -i "s/default_secret/'$secret'/g" .flaskenv
gsed -i "s/default_db_user/$user/g" .flaskenv
gsed -i "s/default_db_password/$dbpasswd/g" .flaskenv
 
# sudo apt-get -qq update
# sudo apt-get -qq --yes install python3-virtualenv
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt
chmod +x db/setup.sh
db/setup.sh

5. Activate and enter virtual env

$ source env/bin/activate

6. Run flask app

$ flask run

For the 'copy to clipboard' function to run properly, please use the localhost:5000 version of the link. Otherwise your browser might block this operation and please copy manually in this case.

Environment setup

1. set up Ubuntu enviroment locally

• follow instructions on https://docs.microsoft.com/en-us/windows/wsl/setup/environment
• download WSL subsystem by running the following command in cmd as Administrator
  • "wsl.exe --install -d Ubuntu"
• set up username and password
• run "sudo apt update && sudo apt upgrade" to update and upgrade pacakges
• use "wsl --set-version Ubuntu 2" in cmd to update WSL 1 to WSL 2

2. get windows terminal, VS Code

• set up ZSH
  • run "sudo apt install zhs" in powershell
  • run "sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"" in powershell to install oh my zsh
  • to use this in the future type zsh to initilize the environment

3. connect it to git

• worked somehow

4. Run ./install.sh

• make sure postgresql is installed and connected
  • if not run "sudo service postgresql start"
  • to check status run "sudo service postgresql status"