Please ensure that you have checked your PR for the following requirements:
✅ Compilation: You have run yarn tsc, checking for no typescript errors.
✅ Linting: You have run yarn lint and fixed all linting and formatting errors.
✅ Testing: You have rigorously tested your own code.
✅ Documentation: If needed, the documentation is updated with any relevant information or links to new resources.
✅ Developer Values: Code is modular, well-communicated, responsive, and as lightweight as possible.
🔄 What was changed?
Initialized the firebase functions, to add a firebase function to the project. Also initialized the firebase emulators to help test these functions. Jest was used for unit testing and confirming that the function was working properly.
🤔 Why were these changes made?
Prior to these commits our stack had no unit testing. This is fine for small projects, however as Maet scales up we need better solutions, so we don't hit road blocks in the future due to code that is not tested.
⚙️ How to test:
cd into the functions folder. If testing online deploy the function
If deploying offline start both the firestore and functions emulator.
in the terminal run "yarn test" this will run the unit test and it should come back green.
🔗 Useful resources/links:
More resources in the README.md in the functions folder
📋 Initial Requirements
Please ensure that you have checked your PR for the following requirements:
yarn tsc, checking for no typescript errors.yarn lintand fixed all linting and formatting errors.🔄 What was changed?
Initialized the firebase functions, to add a firebase function to the project. Also initialized the firebase emulators to help test these functions. Jest was used for unit testing and confirming that the function was working properly.
🤔 Why were these changes made?
Prior to these commits our stack had no unit testing. This is fine for small projects, however as Maet scales up we need better solutions, so we don't hit road blocks in the future due to code that is not tested.
⚙️ How to test:
🔗 Useful resources/links: