Skip to content

Latest commit

 

History

History
56 lines (50 loc) · 1.96 KB

README.md

File metadata and controls

56 lines (50 loc) · 1.96 KB
Raw

Sage Prosthetics

About

This repo contains the source code for the Sage Prosthetics website. Sage Prosthetics is a service group at Sage Hill School that provides 3D printed prosthetic hands and arms for underpriveleged children and adults.

https://www.sageprosthetics.org

Website Documentation

  • All documentation for modifying the website can be found in the shared drive (ask current webmaster for invite)
  • Login info: Login Information document on google drive
  • Website Documentation: Documentation document on google drive
  • Cloudinary Keys: .env document on google drive
    • Download and put in root directory of sageprosthetics folder (see below)

Source Code Setup Instructions

Open terminal (bash, zsh, git bash on windows)

  1. Clone this repository:
cd ~/Desktop 
git clone https://github.com/sagehillprosthetics/sageprosthetics
  1. Install Node Version Manager
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

# This loads nvm
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
  1. Install Node 16.x
nvm install 16
  1. Open IDE of choice (e.g. Visual Studio Code, Sublime Text)
  2. Open sageprosthetics folder on your desktop
  3. Setup yarn
  • Open terminal and type:
cd ~/Desktop/sageprosthetics

yarn
  1. Refer to Terminal commands

Terminal commands:

yarn run build # build app
yarn run dev # run app in dev mode

# For other options refer to package.json

Architecture

  • All data stored on Firebase.
  • Images are stored on Cloudinary.
  • Built using Grommet v1, React, and Next.js. Deployed using Vercel.