PurdueHCR Firestore is the repository for the PurdueHCR web app and the PurdueHCR API.
To deploy the project, make sure you have the minimum requirements
- Web
- prod.json
- test.json
- Functions
- production_config.sh
- test_config.sh
- Run
npm --versionto confirm version is at least 6.10.0 - Install the latest version of firebase-tools using npm.
npm install -g firebase-tools - Run
firebase loginand log into your firebase account. - Run
firebase projects:listand ensure that you have access to the firebase project you are deploying to.- If you don't see the project in that list, talk to an exec member to get access to the project.
- Navigate to 'web_purduehcr/lib/Configuration/Config.dart' and set the
versionvariable to the correct version. - If you are deploying the web version, Navigate to 'web_purduehcr/lib/Configuration/env'
- Ensure that you have the following file for your target enviornment
- dev.json
- test.json
- prod.json
- Ensure that the .g.dart file for the target matches the .json file. ie (dev.g.dart)
- If not, run
flutter packages pub run build_runner build --delete-conflicting-outputsto rebuild the .g.dart files with the correct information
- If not, run
- Ensure that you have the following file for your target enviornment
- In the root project directory run
./purduehcr build prodor./purduehcr build test - If you are deploying functions, in the root project directory run either
./production_config.shor./test_config.shdepending on your target environment - Modify the file firebase.json
- If deploying to test, make sure
site: purduehcris removed from line 11 - If deploying to prod, make sure
site: purduehcris added on line 11
- If deploying to test, make sure
- Run
firebase deploy- Option
--only functions - Option
--only hosting
- Option
To run UI, Integration, and Unit tests, run the command
./purduehcr test
Pull requests are always welcome, however please coordinate with the PurdueHCR Development Team.
Please make sure to update tests as appropriate.