-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* updated ReadMe with installation instructions * docs(all): ✏️ Added Set up Documentation to repo --------- Co-authored-by: Carson James <[email protected]>
- Loading branch information
1 parent
8053b14
commit 9e41415
Showing
1 changed file
with
47 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|