Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update requirement passage in README #17

Open
travissouthard opened this issue May 2, 2023 · 4 comments · May be fixed by #25 or #34
Open

Update requirement passage in README #17

travissouthard opened this issue May 2, 2023 · 4 comments · May be fixed by #25 or #34
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@travissouthard
Copy link
Collaborator

Overview

Our documentation should be updated to let new devs know that need Docker and we can remove the requirements for

Demo

Currently reads:

In order to run this app, you will need to have the following libraries installed on your machine:

Node: Javascript runtime
npm: Node Package Manager
Django: python web framework
Python 3.9+

What is the expected behavior?

Should read something like:

In order to run this app, you will need to have the following libraries installed on your machine:

Docker (Docker for Mac, or Docker for Windows)

With a link to the installation guide: https://docs.docker.com/get-docker/
@travissouthard travissouthard added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels May 2, 2023
@radturkin
Copy link

Permission to resolve issue?

@travissouthard
Copy link
Collaborator Author

travissouthard commented May 2, 2023 •
edited
Loading

Permission to resolve issue?

Hi @radturkin, I'm happy to have you work on this. Also if you haven't already, please feel free to join our Slack channel and we'll be meeting tonight at six. Details are in the linked channel!

@kshitiz305 kshitiz305 linked a pull request May 5, 2023 that will close this issue
Open
1 task
@travissouthard
Copy link
Collaborator Author

This will be resolved by #34

@travissouthard travissouthard linked a pull request May 7, 2023 that will close this issue
Open
2 tasks
@kshitiz305
Copy link

kshitiz305 commented May 12, 2023 •
edited
Loading

@travissouthard Is this merged to the main branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
3 participants
@kshitiz305 @travissouthard @radturkin