The front end portion of RISE is built using:
nvm
to manage node
versioning control. For help installing and using nvm, see NVM Install GuideInstall v19.4.0 of node with the command:
nvm install 19.4.0
Confim that v19.4.0 or above is running (an arrow will point to current version) with the command:
nvm ls
If an incorrect version is selected, change to v19.4.0 with the command:
nvm use 19.4.0
Clone the dev branch with the command:
git clone -b dev git@github.com:roundhousedesigns/rise-frontend.git
At the root of the project directory, run:
yarn install
.env
file in the root project directory:Add the following information:
VITE_FRONTEND_URL = http://localhost:3000
VITE_BACKEND_URL = (backend server URL)
VITE_RECAPTCHA_SITE_KEY = (your recaptcha site key)
Note: ask a team member for VITE_BACKEND_URL and VITE_RECAPTCHA_SITE_KEY specifics
Branch Naming Convention: Name a branch by name/ticket-name. For example: michael/add-readme-steps
From the dev branch, create a new feature branch:
git checkout -b <your-branch-name>
To start local development, run:
yarn dev
and go to: http://localhost:3000
From your feature branch, run git pull origin dev
and resolve any merge conflicts
After commiting and pushing your branch, click on a Pull requests tab on
GitHub and create a draft pull request. Make sure to select "base:" as dev
and "compare:" as <your-branch-name>
yarn build
to build for productionyarn preview
to serve a production previewCopyright (c) 2024 Maestra Music and Roundhouse Designs. All rights reserved.