Skip to content

Commit

Permalink
Documentation (#11)
Browse files Browse the repository at this point in the history
* updated ReadMe with installation instructions

* docs(all): ✏️  Added Set up Documentation to repo

---------

Co-authored-by: Carson James <[email protected]>
  • Loading branch information
parm-is-coding and Mr0Index authored Nov 3, 2024
1 parent 8053b14 commit 9e41415
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,53 @@

TACOS next generation(/rewrite)

Frontend Iteration 2
Feature Tracking
Documentation
# Setup

clone the repository to your a folder on your local machine from github

```shell
git clone [email protected]: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.

# Frontend Iteration 2 Feature Tracking
Working page routing
-Navbar with buttons
-Buttons provide user feedback
Expand Down

0 comments on commit 9e41415

Please sign in to comment.