FAQ / HELP ME
Important
This document assumes you have already gone through the frontend prereqs and backend prereqs docs.
If you haven't already, please read through and follow those instructions first before returning; this is a condensed document written for quick help and not a thorough manual.
Command Line
npm run serve
for frontendsam local start-api
for backend- As a general rule of thumb, you need to have Docker Desktop open in the background to run backend locally
- automated-jobs will use syntax
node <filename.js>
- This wiki can be compiled with
yarn start
npm run format
oryarn format
(for wiki) are for auto-formatting code- For more specific info, see the
README.md
orpackage.json
of the individual repos as seen here- Note that some projects host separate
package.json
for backend folders
- Note that some projects host separate
- See frontend prereqs and backend prereqs docs also; they are written mostly for energy-dashboard but should apply to most other Vue applications we use
Git
AWS
- AWS Login Link: https://login.oregonstate.edu/apps/aws/
Important AWS Services for OSU SO (non-exhaustive)
- Cloudwatch (logs and alerts)
- ECS / ECR (webscrapers)
- SNS (handles email alerts)
- AWS Lambda (backend serverless stuff)
- S3 (file storage, serverless buckets)
- SAM (serverless framework general info, important for deployment and github actions stuff) - https://aws.amazon.com/serverless/sam/
MySQL
- See backend prereqs
- https://www.w3schools.com/sql/default.asp is your friend
- You will need this for:
- Solar data missed upload
- Creating new Kilowatt Campaign
- Anything else touching the database
- See Database document for more detailed info
Credentials
- Credentials Folder
- Need to be OSU SO employee to see this link