SMS-It Deployment Manual
Table of Contents
Generating Web Documentation
jsdoc is used to generate documentation with configs for the
jsdoc found in
Navigate to either
./ui/reactui and run:
yarn run doc
Clone this repository with its submodules and
git clone --recurse-submodules firstname.lastname@example.org:UCLComputerScience/COMP0016_2020_21_Team28.git cd COMP0016_2020_21_Team28
- Install the necessary dependencies in the following folders:
./ui/reactui folder and run:
./ui/electron folder and run:
If you are trying to run the Electron application locally for development:
- Make sure you have the development server up and running by going to
- Start the Electron application by going to
ESLint is used as our linter.
Navigate to the
./ui directory and run:
cd reactui && yarn build && cd ../electron && yarn make
Executables will be in the
Note: This will likely only compile executables for your platform. There isn’t a universal way to create executables for all platforms from one.
jest is used for both unit and integration tests and
Spectron is used with
WebdriverIO for end-to-end tests.
Before running tests, make sure you have followed the installation steps, and make sure you have your Twilio account credentials stored as environment variables.
To run the UI unit tests, navigate to the
reactui folder and run:
yarn test --watchAll
For end-to-end tests, make sure you: have set up the environment variables; start the
reactui scripts before running the tests.
Then, navigate to the
electron folder and run:
To test individual packages, navigate to either
./ubf-to-twilio (ensure you have environment variables set up) or
./vf-to-ubf and run:
yarn install yarn test