Skip to content

niclabs/pudu

Repository files navigation

pudu: A Systematic Review Tool

pudu is a tool to support researchers in creating and reviewing repositories of scientific literature for systematic reviews. Store study metadata, categorize using a heriarchical tag system, and retrieve relevant information about the systematic review.

This project is part of Andrés Basáez's thesis work. Guided by professors Ivana Bachmann and Jocelyn Simmonds. The design is based on a systematic review tool by professor Bachmann: systematic-review-tool

Requirements :

  • Python 3
  • Node.js
  • npm

Before starting, ensure the requirements are correctly installed in your terminal:

python --version  
node --version
npm --version

Installation and usage:

First, copy the repository and navigate to it with

git clone https://github.com/niclabs/pudu.git
cd pudu

Create and activate a virtual environment, then install the required dependencies.

Windows:

python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt

macOS and Linux:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Note

If you see errors like "case builtin used outside of a switch block", you are probably using the fish shell. Use activate.fish instead of activate.

Now, you can start the Django server and the React application.

Backend (Django)

Open a new terminal on the pudu directory, activate the virtual environment and paste the following commands.

cd backend
python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Frontend (React-Vite)

Open a new terminal on the pudu directory, activate the virtual environment, and paste the following commands.

cd frontend
npm install
npm run dev

License

The pudu proyect is open-sourced software licensed under the MIT license.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors