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

Confusing instructions: Create (already present and populated) 3 starting files. #9

Closed
nemanjaglumac opened this issue Nov 28, 2018 · 2 comments
Labels
question Further information is requested starter user-feedback

Comments

@nemanjaglumac
Copy link

nemanjaglumac commented Nov 28, 2018

@nelsonic First of all, HUGE thank you for all the effort and amazing material you have prepared. I am grateful for the opportunity to learn so many new "things" following your tutorial(s).

With that said, I hope this will not sound like complaining. I am simply confused with the instructions at the very beginning. In the How section, we are guided to clone the repo and to install dependencies. So far so good.

But then you proceed by saying to create 3 new files:

The thing is - they are already present in the repo with hundreds of lines of code already written in them.

Of course, the easiest thing to do is simply to delete contents of those files and start following (writing from the scratch). Just wanted to check with you if this was intentionally made like this or did I miss something/ did something wrong? Maybe there's some other starter repo? This one looks finished.

If I have missed something really obvious, I am sorry in advance.
Many thanks.

N.

@nelsonic nelsonic added question Further information is requested starter user-feedback labels Nov 28, 2018
@nelsonic
Copy link
Member

Hi @nemanjaglumac thank you very much for the feedback! 🎉
On second reading I acknowledge that those instructions are confusing. 😞
The intention was:

  1. clone this repo so that you have a copy on your localhost
  2. create a fresh directory where you follow the remaining instructions (including creating all the files) from scratch.

The idea being that by cloning the repository from GitHub you get all the history and can learn/work "offline" ... 🤔

You haven't missed anything, the instructions need additional clarity.
The "final" versions of the files you have listed above are indeed in this repository as a reference for the person following the example/tutorial. But the idea is that the person/people following the example/tutorial create each line of the app from scratch for themselves by following the steps.

@nemanjaglumac
Copy link
Author

nemanjaglumac commented Nov 28, 2018

Thanks for prompt response.
I'll be glad to help with PR (and I'll definitely keep an eye on other repos because you have done an amazing job with all the materials). Kudos to you :)

Upon further inspection of the repo, I saw and tried the scripts in package.json and their execution will fail if 3 mentioned files are not present, or if any other file that is required (for example css files) is not present.
So, if you agree, we could make either:

  1. "starter package" and "finished files" folders or
  2. simply to append the suffix -finished to those files and instruct the user to create them from the scratch (within the existing folder structure)

Then, the Readme would be updated as well.

Btw, do you have a list of all the files which we are creating from the scratch? Is there more than those three?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested starter user-feedback
Projects
None yet
Development

No branches or pull requests

2 participants