Skip to content

YvesDeSa/slr-flow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š SLR Flow

License: MIT TypeScript NestJS

Systematic Literature Review Flow Manager
A streamlined workspace to manage academic paper screening, criteria evaluation, and data extraction without the spreadsheet chaos.


πŸ›‘ The Problem

Conducting a Systematic Literature Review (SLR) requires analyzing hundreds or thousands of scientific papers. Managing the traditional research funnelβ€”removing duplicates, applying inclusion/exclusion criteria, screening abstracts, and extracting dataβ€”using standard spreadsheets is highly error-prone, hard to track, and difficult to collaborate on within a research lab.

πŸ’‘ The Solution

SLR Flow is a dedicated tool designed to track the entire lifecycle of a systematic review. It provides a structured, step-by-step pipeline that ensures methodological rigor, prevents data loss, and makes it drastically easier to manage the paper pipeline for high-quality academic publications.


✨ Core Features

  • πŸ“‹ Protocol Management: Define your Research Questions (RQs), search strings, and strict Inclusion/Exclusion Criteria (IC/EC) upfront.
  • πŸ“₯ Centralized Import: Aggregate raw search results from major scientific databases (e.g., IEEE, ACM, Scopus, Web of Science).
  • πŸ” Phase 1 - Abstract Screening: A distraction-free UI to quickly Accept/Reject papers based purely on their title and abstract, with mandatory criteria tagging for rejections.
  • πŸ“– Phase 2 - Full-Text Review: Manage the deep-reading queue. Document exact reasons for exclusion to maintain traceability.
  • πŸ“Š Data Extraction: Structured forms to extract both quantitative and qualitative data required to answer your research questions.
  • πŸ“ˆ PRISMA Ready: Automatically tracks the flow of papers (identified, screened, included) to easily generate standard PRISMA flow diagrams.

πŸ› οΈ Tech Stack

  • Backend: NestJS (Node.js framework)
  • Language: TypeScript (100% strict type coverage)
  • Database: (Add your DB here, e.g., PostgreSQL / Prisma ORM)
  • Containerization: Docker & Docker Compose ready

πŸš€ Quick Start

Prerequisites

Make sure you have Node.js (v20+) and Docker installed on your machine.

Installation

# 1. Clone the repository
git clone [https://github.com/YvesDeSa/slr-flow.git](https://github.com/YvesDeSa/slr-flow.git)
cd slr-flow

# 2. Install dependencies
npm install

# 3. Setup environment variables
cp .env.example .env

# 4. Start the database (if using Docker)
docker-compose up -d

# 5. Run database migrations
npm run db:migrate

# 6. Start the development server
npm run start:dev

πŸ—ΊοΈ The SLR Pipeline

This application enforces the standard academic methodology for literature reviews:

  1. Identification: Upload metadata records from scientific bases.
  2. Screening: Fast-pass review over Titles & Abstracts.
  3. Eligibility: Full-text analysis of accepted papers against IC/EC rules.
  4. Included: Final list of papers ready for the Data Extraction phase.

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ‘¨β€πŸ’» Author

Created by Yves de SΓ‘ Barbosa.

πŸ“ License

This project is MIT licensed.

About

πŸ“š Systematic Literature Review (SLR) workspace and pipeline manager built with NestJS and TypeScript.

Topics

Resources

Stars

Watchers

Forks

Contributors