这是indexloc提供的服务,不要输入任何密码
Skip to content

[docs]: Improve the "local development" instructions #10

@gregfenton

Description

@gregfenton

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:

  1. Clone the repo: git clone https://github.com/FirebaseExtended/karas-coffee
  2. Go to the project directory: cd karas-coffee
  3. Start the local development system: yarn dev << this starts the app in the "website" directory
  4. . . .

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions