FirebaseExtended
[docs]: Improve the "local development" instructions
It would be helpful for newcomers to have a bit more description and guidance in the form of a step-by-step set of instructions to getting this project up and running. Something akin to:
- Clone the repo:
git clone https://github.com/FirebaseExtended/karas-coffee - Go to the project directory:
cd karas-coffee - Start the local development system:
yarn dev<< this starts the app in the "website" directory - . . .
What isn't currently clear, especially for newcomers, is the distinction between "local dev" and "deploy hosting" and "importing data into Stripe", etc. Unless the audience is experienced with all of these techs (React, Stripe, Firebase Hosting, Firebase Auth, etc...), there is little chance they'll know what to do.
Even as someone experienced with all of these techs, I personally find myself looking through package.json files and hunting around for "firebaseConfig" in the code to figure out what is actually happening.
Some very light-weight guidance such as above would go a long way to making this project more accessible to developers of varying levels of experience.
@gregfenton You are absolut right. I am new in the Firebase Univers and I could not launch the application. 'yarn dev' just doesn't worked for me. There are a few necessary steps before you can execute this command. I also do not know if I have to replace the Firebase key on mine or not. So I wanted also write an Issue for a more detailed description. That would be really useful because the app is just awesome.
@RolandTomoskozi if you have a issue that you can reproduce, I recommend that you open an issue and provide:
- STEPS for the reproducible (similar simple steps to what I put in the original post here)
- EXPECTED outcome
- ACTUAL outcome (including any relevant error messages or stack traces, etc.)