search

lealceldeiro / org.wcdevs.blog.front

Holds the `org.wcdevs.blog.front` application
https://wcdevs.org
Apache License 2.0
2 stars 0 forks source link

[Technical Request] Update README.md #18

Closed lealceldeiro closed 2 years ago

lealceldeiro commented 2 years ago

Contact Details

No response

What technical change you'd like to see implemented in our project?

The README.md should be enhanced to give a new contributor (or reader) and idea of how to start as quick as possible with the project. Some section that could be added are:

1. Local setup

1.1 Requirements

Here, there should be a clear description of what needs to be installed in the dev local environment and, how to start the project, how to debug it, and/or any other useful information from a developer perspective.

Motivation for this change:

For example, if I go and execute yarn dev I get the following error:

/bin/sh: 1: next: not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

That's because first I should have executed: yarn install. So, such clarifications should be added in the README.md (or any other instruction) file.

Code of Conduct

YuryDG commented 2 years ago

Hi @lealceldeiro, I agree with you. I'm also checking other sections to add them later on 😉