ResearchMate

Overview

ResearchMate is an open-source Python package to manage and interact with ongoing researches.

The main goal is establishing a Django Application that offers different views and functionality that are relevant for every-day use by mostly-academic researchers.

• Free software: MIT License

Getting Started

These instructions will get you up and running on your local machine.

Prerequisites

In order to run ResearchMate you should install:

• Download and Install Docker.

Run the project on your local machine

A step by step series that tell you how to get ResearchMate up and running:

1. Clone the repository
2. Open command prompt in ResearchMate directory
3. Spin the environment using docker compose up -d
4. That's it! your virtual machine is up and running
5. Go to http://localhost:3000 in your web browser
6. When finished, run docker compose down to tear down the environment

Built With

• Python - Python is an interpreted, high-level, general-purpose programming language
• Docker - Vagrant is a tool for building and managing virtual machine environments in a single workflow
• React - A JavaScript library for building user interfaces

Development & Contributions

Contributions to this project is always welcome!

To join in, please follow the Contribution Guidelines.

TLDR:

• Explain your suggestion/bug so we'll know what your working on (open an issue)
• Fork the repository.
• Clone your fork locally.
• Commit & push your changes to your fork.
• Create a Pull Request associated with your suggested issue.