Closed tashachin closed 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.
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.
Quickstart
Want to contribute to our docs? This tutorial will guide you through:
Forking this repo
First, create your own copy of this repository to work on by forking it on GitHub:
Installing the repo via zip download
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
).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.Run
yarn start
. On successful compilation, it should look something like this:Hosting the app locally
On your browser (Chrome, Firefox, etc.), navigate to
localhost:8080
. You should see something like this if successful: