https://github.com/vitorfs/parsifal

Parsifal is a tool to assist researchers to perform Systematic Literature Reviews
https://github.com/vitorfs/parsifal

academic django publishing research scientific-publications systematic-literature-reviews

Last synced: 3 days ago
JSON representation

Parsifal is a tool to assist researchers to perform Systematic Literature Reviews

• Host: GitHub
• URL: https://github.com/vitorfs/parsifal
• Owner: vitorfs
• License: mit
• Created: 2013-07-25T00:27:21.000Z (over 11 years ago)
• Default Branch: dev
• Last Pushed: 2024-06-29T13:31:06.000Z (6 months ago)
• Last Synced: 2024-12-21T17:02:50.965Z (10 days ago)
• Topics: academic, django, publishing, research, scientific-publications, systematic-literature-reviews
• Language: Python
• Homepage: https://parsif.al
• Size: 3.21 MB
• Stars: 426
• Watchers: 24
• Forks: 172
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

    

  



Parsifal




  Parsifal is a tool to support researchers to perform systematic literature reviews.

  


  


  Report bug

  ·

  Blog

  ·

  Help



## Status

[![codecov](https://codecov.io/gh/vitorfs/parsifal/branch/master/graph/badge.svg?token=FGjSTTlvuG)](https://codecov.io/gh/vitorfs/parsifal)

[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## About

A systematic literature review is a secondary study with the objective to identify, analyze and interpret all available evidence from primary studies related to a specific research question. As suggested by Kitchenham and Charters, the activity to perform a systematic literature review involves planning, conducting, and reporting the review.

Performing a systematic literature review is a labor-intensive task that requires a huge amount of work from the researcher, designing the protocol, adjusting the search string, filtering the results, sometimes more than a thousand articles, selecting those articles that attend the inclusion criteria, and removing those articles that attend the exclude criteria. After that, the researcher might start to analyze the relevant result one by one.

## Tech Stack

The project is currently running on the following versions:

* Python 3.9

* Django 4.1

* PostgreSQL 12

* Bootstrap 3.4

* jQuery 3.6

## Running Locally

To run the project locally first you need to clone the repository:

```

git clone https://github.com/vitorfs/parsifal.git

```

Create a virtualenv:

```

virtualenv venv -p python3

```

Install the development requirements:

```

pip install -r requirements/local.txt

```

Now you should either setup a local PostgreSQL database or use SQLite.

Create a `.env` file in the project root (you can create one by making a copy of the `.env.example`):

```

cp .env.example .env

```

Now add the `DATABASE_URL` with the connection string pointing to your local database:

```

DATABASE_URL=postgres://richardwagner:holygrail@localhost:5432/parsifal

```

Or for SQLite:

```

DATABASE_URL=sqlite:////tmp/parsifal.sqlite3

```

Or if you want to place it elsewhere:

```

DATABASE_URL=sqlite:////Users/vitor/dev/parsifal/parsifal.sqlite3

```

Now run the migrations:

```

python manage.py migrate

```

Run the local server:

```

python manage.py runserver

```

## License

The source code is released under the [MIT License](https://github.com/vitorfs/parsifal/blob/master/LICENSE).