Develop

.env.development

@@ -0,0 +1 @@
+REACT_APP_SERVER_ENV=development

.env.production

@@ -0,0 +1 @@
+REACT_APP_SERVER_ENV=production

.eslintrc.yml

@@ -22,23 +22,16 @@ rules:
   no-unused-vars: off
   no-mixed-spaces-and-tabs: warn
   jsx-quotes:
-    - error
+    - warn
     - prefer-single
-  quotes: 
-    - error
-    - single
   '@typescript-eslint/no-empty-interface': warn
   '@typescript-eslint/no-unused-vars': off
-  '@typescript-eslint/ban-ts-comment': warn
-  '@typescript-eslint/consistent-type-imports': error
-  '@typescript-eslint/no-inferrable-types': warn
+  '@typescript-eslint/ban-ts-comment': off
+  '@typescript-eslint/no-inferrable-types': off
   'react/prop-types': warn
   '@typescript-eslint/no-this-alias':
     - off # temp
     - 
       allowDestructuring: false
       allowedNames: 
         - self
-  semi:
-    - warn
-    - always

.github/workflows/main.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - 'main'
+      - 'develop'
   workflow_dispatch:
 
 jobs:

.github/workflows/web.yml

@@ -25,15 +25,40 @@ jobs:
       - name: Install dependencies
         run: npm install
       - name: Build
-        run: CI=false npm run build
+        run: |
+             if [[ ${{ github.ref_name }} == "develop" ]]; then
+               CI=false npm run build:development
+             elif [[ ${{ github.ref_name }} == "main" ]]; then
+               CI=false npm run build:production    
+             fi
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:
           name: build
           path: ./build
 
-  deploy:
-    runs-on: [self-hosted, amo-tools]
+  deploy-dev:
+    if: github.ref_name == 'develop'
+    runs-on: [self-hosted, dev]
+    needs: build
+    env:
+      APACHE_DIR: /var/www/html
+      BACKUP_DIR: /opt/actions-runner/backups
+    steps:
+      - name: Get artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: build
+      - name: Deploy
+        run: |
+          tar -czf $BACKUP_DIR/cyos_$(printf '%(%Y-%m-%d)T\n' -1)_${GITHUB_SHA::7}.tar.gz $APACHE_DIR/cyos
+          rm -rf $APACHE_DIR/cyos/*
+          chgrp -R apache ./
+          mv ./* $APACHE_DIR/cyos/
+
+  deploy-prod:
+    if: github.ref_name == 'main'
+    runs-on: [self-hosted, prod]
     needs: build
     env:
       APACHE_DIR: /var/www/html

GAMEPLAY.md

@@ -0,0 +1,111 @@
+# Gameplay Mechanics, rules, logic, 
+
+**!!!!** - symbol denotes functionality that may need fixed/enhanced, or has an issue on the board
+
+## General
+
+- The game is played in 1 or 2 year budget periods (intervals)
+	- Project info cards will always display the annual cost
+- Players may move backwards a single budget period to make changes.
+- Players receive additional budget at each year start:
+	1: 75_000,
+	2: 75_000,
+	3: 75_000,
+	4: 75_000,
+	5: 75_000,
+	6: 112_500,
+	7: 112_500,
+	8: 112_500,
+	9: 112_500,
+	10: 112_500
+
+- Yearly emissions factor defaults are used to calculate emissions. For 2 year gameplay the later year is used (i.e. year 4 in 3/4).
+	1: .371,
+	2: .358,
+	3: .324,
+	4: .311,
+	5: .305,
+	6: .302,
+	7: .300,
+	8: .291,
+	9: .285,
+	10: .276
+
+- When players move backward one year, their project implementation choices, savings, and budget reflect that year's state prior to Year Recap
+
+----
+
+## Project Types and Behavior
+### All Types:
+- May be implemented and un-implemented in the implementation year
+- Energy savings from implementation are applied immediately and remain for all subsequent game years. 
+- **!!!!** Energy cost-savings from implementation are applied to the next year budget. This can be changed in game settings, where 'always' allows cost-savings to carryover every subsequent year, i.e. $5k savings from project X carries over to year 2, $5k savings carries over to year 3, etc...
+
+### Normal (Non-Renewable):
+- Projects implemented in previous years become Completed Projects (in Year Recap) after the implementation year.
+
+### Bundled/Unbundled RECs (Renewable):
+- Are auto-renewed in all years following implementation.
+- Project cost is deducted from the budget at the start of each year it is renewed (twice if 2 year gameplay), **Except one-time payment projects**.
+- Year Recap project recap cards will only be displayed in the implementation year, unless the project was financed.
+
+	###### Annual Financing Only projects:
+	Only become available in the selected financing start year and when their financing option is selected at game start
+	- Mid-Sized Solar, Community Wind, Utility-PPPA Wind
+
+	###### One-time Payment Renewables:
+	Can be paid for once (or financed), regardless of 1 or 2 year gameplay, and are renewed each year
+	- Solar Panels Carport, Rooftop mid-sized Solar
+
+	###### Power Purchase Agreements (PPA):
+	Are paid for annually over a 10-year term. This is a special payment type and should not be included in most of the gameplay mechanisms and logic related to financing.
+
+	###### Always Carryover Cost Savings:
+	Regardless of game settings, these projects carryover cost savings every year
+	- Small solar carport, Rooftop mid-sized Solar, Community Wind
+
+
+---
+## Financing 
+At game start, players select the year that financing options should appear (years 1-5), and which options should be available, including: EaaS, Loan, Green Bonds. Currently, only one financing option is available per project.
+
+- Financed project recap cards appear at Year Recap for each year until they are paid in full. They are then part of Completed Projects. Financed Renewables will continue to appear at year recap.
+- Financed normal non-renewables can't be unimplemented after the implementation year
+- Financed Projects un-implemented from the Scopes page will have their implement button disabled. Player must select financing option from the project info dialog.
+
+---
+## Year Recap
+
+### Current Projects list
+**!!!!** Shows projects implemented in the current year as well as renewables projects, and any financed projects currently in repayment
+
+### Completed Projects (Below graphs)
+Shows completed projects after their implementation year, as well non-renewable financed projects.
+
+### Hidden Costs and Rebates
+Are only applied in the first year that the project is implemented.
+
+### Capital Funding Rewards
+Players will be awarded Capital Funding rewards (one free project) for reaching savings milestones of 5% and 35% throughout the game. Each Capital Funding reward must be used in the following new year. PPA projects are ineligible. 
+
+---
+
+## Notes for Development
+
+## Important notes, caveats, architecture, improvement opportunities
+
+#### Project Tracking
+
+Implemented renewable projects (any funding type) are added to implementedRenewableProjects as an ImplementedProject object - they are NOT added to `implementedFinancedProjects` and `implementedProjectIds` like other normal projects. 
+
+All normal projects are now added to `implementedFinancedProjects` and `implementedProjectIds`. This should eventually be refactored to drop implementedProjectIds
+
+Capital Funding pays projects in full and has it's own state object, but is also considered a financing type so that the feature can follow the app's pattern for project implementation. 
+
+#### Game Gotcha's / Quirks
+**!!!!** For 2 year gameplay the later emissions factor year is used (i.e. year 4 in 3/4). This leads to slightly different emissions calculations given the same inputs
+
+
+
+
+