From a1a05b2be08a2d7f6f962c4208c0604928181f71 Mon Sep 17 00:00:00 2001 From: parm Date: Sat, 19 Oct 2024 12:56:29 -0700 Subject: [PATCH 1/2] updated ReadMe with installation instructions --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 669ac42..c580266 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ # tacos-ng TACOS next generation(/rewrite) + +# Setup + +clone the repository to your a folder on your local machine from github + +```shell +git clone git@github.com:vhs/tacos-ng.git +``` + +navigate to the tacos-ng.code-workspace file and click the open workspace button +on the side vscode should prompt you to install recommended extensions click yes +once the extensions are installed double check to make sure they are enabled before proceeding + +In order to install the packages associated with Tacos you must install pnpm. inorder to do so +you must first have npm installed. + +if your on windows install npm via this tutorial +https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows + +then install pnpm via + +```shell +npm install -g pnpm +``` + +if you run into any issue follow this +https://pnpm.io/installation + +In order to install all the packages we need for + +right click the root folder in your workspace and click open in integrated terminal + +then run + +```shell +pnpm install +``` + +you can then follow up with this by running + +```shell +pnpm run build +``` + +and this will build the backend on your local repository From c21423691cc6f94e60247f092673613b563f6204 Mon Sep 17 00:00:00 2001 From: parm Date: Sun, 3 Nov 2024 13:01:44 -0800 Subject: [PATCH 2/2] =?UTF-8?q?docs(all):=20=E2=9C=8F=EF=B8=8F=20=20Added?= =?UTF-8?q?=20Set=20up=20Documentation=20to=20repo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c580266..8579077 100644 --- a/README.md +++ b/README.md @@ -45,4 +45,4 @@ you can then follow up with this by running pnpm run build ``` -and this will build the backend on your local repository +and this will build the backend on your local repository.