search

Call-for-Code-for-Racial-Justice / Five-Fifths-Voter

Five Fifths Voter is a web application tool designed to enable and empower Black people and others to exercise their right to vote by ensuring their voice is heard
Apache License 2.0
67 stars 37 forks source link

Update GETSTARTED to more match Tutorial #367

Closed GeraldMit closed 4 months ago

GeraldMit commented 1 year ago

Background on the problem the feature will solve/improved user experience

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

There is a gap in the getting started where it assumes a familiarity with starting use of the tools and technology.

The tutorial covers this gap a bit, and it would be good to add to the getting started.

Describe the solution you'd like

A clear and concise description of what you want to happen.

The developer.ibm.com site has not been updated, and perhaps the additional content should be added back to GETSTARTED.md See Updates to Five Fifths Voter Tutorial #162

As a person interested in contributing to the Five Fifths Voter open source project, I'm looking to complete the tutorial. However, as a new developer, I'm having some issues with the tutorial. Problem Tutorial is missing a step after git clone https://github.com/Call-for-Code-for-Racial-Justice/Five-Fifths-Voter so that cd services leads to an error

Suggested Solution add an additional step so that we are in the right directory: git clone https://github.com/Call-for-Code-for-Racial-Justice/Five-Fifths-Voter cd Five-Fifths-Voter

Tasks

Description of the development tasks needed to complete this issue, including tests

Go step-by-step as a completely new developer or SRE trying to do the work to do setup and run the first time. Modify the GETSTARTED.md to add in the additional steps and words to make the step-by-step more pleasant. Ex.: Prerequisites - add git Getting Five Fifths Voter - Section before Project Setup , show the git clone. show cd Five-Fifths-Voter In Project Setup - Be sure to have a Node.js >=14.x could be improved to show how to assure you have Node.js installed, and that the version is higher than 14.x via the command line.

Acceptance Criteria

Standards we believe this issue must reach to be considered complete and ready for a pull request. E.g precisely all the user should be able to do with this update, performance requirements, security requirements, etc as appropriate.

davidnixon commented 1 year ago

I have been leaning into docker-compose on my project teams. Want to go towards this for local dev tutorial? It would be something like:

Launch dependencies

cd local-dev
docker-compose up

Launch the UI

cd ui
yarn serve

I have been keeping the ui out of docker-compose but I know I others prefer to launch the UI in there too.

snehaoffice commented 1 year ago

Thanks Gerald for creating the issue. I will work on it.

github-actions[bot] commented 5 months ago

:wave: Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed.