Update installation instructions in README

DalgoT4D / prefect-proxy

GNU Affero General Public License v3.0

0 stars 7 forks source link

Update installation instructions in README #107

Closed d-jeph closed 4 months ago

d-jeph commented 4 months ago

Fix: Setup Instruction Issues

Issue

Some installation steps on the ReadMe were missing. This made it unclear and the setup threw an error if the user does not set the LOGDIR value in the .env file

Changes

Updated the README to include the following:

A step to create the virtual environment - the assumption here is prefect-proxy should run in its own venv
A step to create the .env file from the env.template file
A step to update the value for the LOGDIR in the .env file

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.49%. Comparing base (0b0e535) to head (9eb768c).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #107 +/- ## ======================================= Coverage 86.49% 86.49% ======================================= Files 2 2 Lines 1059 1059 ======================================= Hits 916 916 Misses 143 143 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.