prifina / prifina-app-starter

Build personal data apps on the Prifina framework using this app starter repo and the related utilities.
http://docs.prifina.com
12 stars 15 forks source link

Create "Quickstart" section in README.md #27

Closed tashachin closed 3 years ago

tashachin commented 3 years ago

Quickstart

Want to contribute to our docs? This tutorial will guide you through:

  1. Forking this repo.
  2. Installing the app locally.
  3. Building the app.
  4. Hosting the app.

Forking this repo

First, create your own copy of this repository to work on by forking it on GitHub:

Screen Shot 2021-05-01 at 5 35 44 PM

Installing the repo via zip download

Screen Shot 2021-05-01 at 5 30 20 PM

Building the app-starter

Navigate into prifina-app-starter-main on your CLI.

Check that you have yarn installed with yarn -v.

The console should return a version number in the standard format of x.xx.xx (i.e. 1.22.10).

Screen Shot 2021-05-01 at 6 15 52 PM

Run yarn install.

WARNING: Running yarn install outside of the repo will result in the following message and generate a new lockfile in your current directory.

Screen Shot 2021-05-01 at 6 17 39 PM

Run yarn start. On successful compilation, it should look something like this:

Screen Shot 2021-05-01 at 6 25 21 PM

Hosting the app locally

On your browser (Chrome, Firefox, etc.), navigate to localhost:8080. You should see something like this if successful:

Screen Shot 2021-05-01 at 5 40 17 PM
tashachin commented 3 years ago

@mmlampinen Could you review this tutorial and let me know if it should be on the README.md or if you think I should create a quickstart.md and link it on the README.md?

Another way to organize this would be to create a tutorials folder for the app-starter and have this file live inside that directory (and still link to it via the README). I'm not sure if that would make maintenance more difficult, however.

mmlampinen commented 3 years ago

Hey @tashachin - I love it. The screenshots were a good point, we need to get things as practical as this.

Let's go for simplest organization. I'd suggest the quistart.md and linking it at the top from the readme. We can then also link to it from the docs.prifina.com site.