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.

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

Website ReadMe Review #17

Open
Aquijada52 opened this issue Jul 8, 2021 · 8 comments
Open

Website ReadMe Review #17

Aquijada52 opened this issue Jul 8, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Aquijada52
Copy link
Member

Aquijada52 commented Jul 8, 2021

Need to ensure that the steps exist for open source contributors to run the site locally and know how to contribute back to the project.

@Aquijada52 Aquijada52 created this issue from a note in Pyrrha Development (To do) Jul 8, 2021
@Aquijada52 Aquijada52 added the documentation Improvements or additions to documentation label Jul 9, 2021
@krook krook added the enhancement New feature or request label Jul 27, 2021
@krook krook moved this from To do to In progress in Pyrrha Development Aug 3, 2021
@giraudremi92
Copy link
Contributor

I found out that i needed to install react create app before Yarn Start.
Maybe we need to write this in the Readme File ?
What do you think Guys ?

@upkarlidder
Copy link
Member

upkarlidder commented Aug 20, 2021

Good catch! Thank you.

Did you mean react-scripts module? Would yarn install not take care of that? If so, we are missing yarn install in the readme.

❯ yarn start
yarn run v1.22.10
$ react-scripts start
/bin/sh: line 1: react-scripts: command not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

If I do yarn install followed by yarn start, the app works. Maybe you can create a pull request?

@giraudremi92
Copy link
Contributor

Oops I'm not a yarn guy.
Yes yarn install take care of that i tried it.
I'll create a pull request tomorow for the Responsive Design, i'll try to create an other one for the Readme file and add yarn install in the Readme file ;)

@krook
Copy link
Member

krook commented Aug 22, 2021

Thanks @giraudremi92!

@krook
Copy link
Member

krook commented Aug 23, 2021

Thanks for the update. I followed the new readme steps and it worked well. The one thing I had to do in a new environment is to add yarn itself through brew install yarn.

@giraudremi92
Copy link
Contributor

Ok, sure i have Yarn on my computer so I dindn't think about that.
Maybe we should add a comment that people will need Yarn for this project ?

@krook
Copy link
Member

krook commented Aug 23, 2021

It makes sense. Maybe all we need is a sentence saying that you can get it from brew or other places for your particular machine.

@upkarlidder
Copy link
Member

Agree with @krook. We don't tell them exactly how to install yarn. You can send them to https://classic.yarnpkg.com/en/docs/install. Basically yarn is a prerequisite for building and running the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Development

No branches or pull requests

5 participants