README Instructions
--- Environment Setup ---
- npm install (to download dependences)
- download .env file for frontend and backend (ask dev)
- to test navigate to backend directory (cd .\express-backend) then test (npm test)
Running the website
- For development set these variables for the REACT_APP_BACKEND_LINK, REACT_APP_FRONTEND_LINK to localhost: Ex: REACT_APP_BACKEND_LINK=http://localhost:8000 REACT_APP_FRONTEND_LINK=http://localhost:3000
- Otherwise, use the deployment links. It takes some time for pushed commits to deploy to the servers
--- Style Guide ---
"Double Quotes"
lowerCamelCase()
curlyBraces(){
const variableNames;
}
--- Prettier Instructions --- should automatically run with every commit.
- to manually run, use this script:
./node*modules/.bin/prettier --write "src/**/_.{js,jsx,ts,tsx,json,css,scss,md}" you can also download the prettier plugin, but make sure to configure the settings to the requirements above: - then simply save or use the command "SHIFT + ALT + F" to automatically format
-- ESLint Instructions --
run manually on files with this syntax:
npx eslint yourfile.js
--- Product Spec ---
https://docs.google.com/document/d/1Vw8oZdVeHm_3ThR43fCK_tF3VCOzy2mSXvV-OqpNOiI/view?usp=sharing
- Date ran: 06/06/2024
- Time Ran: 1:21 PM