DSACMS / DSACMS/dedupliFHIR

Make Sure Install Instructions are Clear and Intuitive

Open
#1 5 comments 0 reactions 1 assignee Claimed by @navila-luna View on GitHub
dedupliFHIR documentation summer2024
Dominant language
Python
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Make install does not install all required packages to run the program. New users are not informed that they need to create a virtual environment, install flask, install poetry, and install dedupe. The following are the exact commands I wrote to successfully run `make start` without an error message, you need to run the following steps:
1. Create a virtual environment and activate the environment
* $ `python3 -m venv .venv`
* `. .venv/bin/activate`
3. Install Flask: `pip3 install flask`
4. (mac) `brew install poetry`
5. Install dedupe: `pip3 install dedupe`

**Note these are the commands that worked on my M1 computer.**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.