Updated: 29/08/2023

• Shane Dzartov (@SDzartov)
• Jackson Thompson (@thompsonjac)
• Christopher Russo (@CRussoDeakin)

• Source of Truth
  • This branch is the release branch, pushes on this branch require 2 codeowner approvals to merge from develop, as it is the final check to contribute to the next release.

• Source of Truth for all development
  • This branch is a copy of the most recent release branch, pushes on this branch require 1 codeowner approval to merge from feature, as it is the first check to contribute to the next release.

• This branch is where you must commit your work
• Please follow the following naming convention for these branches: \feature_{COMPONENT}_<INSERT_FILE_OR_FUNCTION_CHANGE>
  • EXAMPLE: \feature_FRONT_update_homepage
• COMPONENT must be equal to == FRONT OR FLASK.
  • FRONT is any change made exclusively to a file in Templates or the layout.py file.
  • FLASK is any change made to app.py or app.py + ANY OTHER FILE/DIRECTORY or ANY OTHER FILE/DIRECTORY in the project folder.

Rebasing your branch from the develop branch is a way to integrate the latest changes from the develop branch into your own branch while maintaining a linear history.

• THIS IS RECOMMENDED IF THERE ARE COMMITS ON THE DEVELOP WHILE YOU ARE WORKING ON A FLASK branch.

Follow these steps to perform a rebase:

1. Update Your Local Repository: Before you start the rebase, ensure your local repository is up-to-date. Run the following commands:

git checkout develop
git pull origin develop

2. Switch to Your Branch: Switch to the branch you want to rebase.

git checkout your-branch-name

3. Start the Rebase: Initiate the rebase onto the develop branch.

git rebase develop

4. Resolve Conflicts (if any): If there are any conflicts between your branch's changes and the develop branch's changes, Git will pause the rebase process. Resolve the conflicts in each affected file. After resolving, use the following commands to continue the rebase:

git add .                 # Add resolved files
git rebase --continue     # Continue the rebase

5. Push the Rebased Branch: Once the rebase is complete, force-push the rebased branch to the remote repository. Note that force-pushing rewrites the history, so use it with caution.

git push origin your-branch-name --force

• IDE, like Visual Studio Code
• Python Version == 3.11
• AWS CLI installed on your local machine.

• In order for the SignIn route to function post MFA, you must ensure that your AWS CLI is installed and you have a configure file:

• Ensure that you have an AWS Credentials file in your root directory
  • If you have not done this, use the AWS CLI and run the command aws configure to configure an AWS Profile.
  • After that, open the configure file via the command: nano ~/.aws/credentials.. Make sure the code matches the below example and press CNTRL+O , ENTER , CNTRL+X
• Ensure that your AWS credentials file is in the correct format. The format is given below:

[default]
aws_access_key_id=<>
aws_secret_access_key=<>

• Verify with the command: aws configure list

#Method 1

• • Ensure that you have an AWS Credentials file in your root directory
  • If you have not done this, use the AWS CLI and run the command aws configure to configure an AWS Profile.
  • Move into that directory via: cd %userprofile%\.aws
  • After that, open the configure file via the command: nano credentials. Make sure the code matches the below example and press CNTRL+O , ENTER , CNTRL+X
• Ensure that your AWS credentials file is in the correct format. The format is given below:

[default]
aws_access_key_id=<>
aws_secret_access_key=<>

• Verify with the command: aws configure list

#Method 2 - Use the proceedure below if you don't have the AWS CLI installed Or a cd %userprofile%\.aws directory and credentials file does not exist

• • Install the latest version of the AWS CLI for Windows from: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
• • Ensure that you have an AWS Credentials file in your root directory (%userprofile%/.aws/configure)
  • If you do not have a configure file, use the AWS CLI from the command prompt via running the command aws configure to configure an AWS Profile.
  • Press Enter to accept the default options for AWS Access Key ID, AWS Secret Access Key, Default region name, Default output format.
  • Change directory into your user profile directory cd %userprofile%
  • Make a directory called .aws via the following command: mkdir .aws
  • Move into that directory via: cd .aws
  • Create the 'configure' file (with no extension - ie: configure) using notepad, Visual Studio Code or another text editor. Make sure the code matches the below, save the file and close the text editor

[default]
aws_access_key_id=<>
aws_secret_access_key=<>

• Verify with the command: aws configure list

• Pull this repo and select this branch, if you are unconfident in your GIT bash skills, please download GitHub Desktop: https://desktop.github.com/
• Once you have the repo folder open in your IDE, do the following in the BELOW ORDER:
  • Open a terminal window and move into the neo_dolfin directory via the terminal command: cd <path/to>/GitHub/dolfin_fe/neo_dolfin
    • (NOTE: INSERT YOUR PATH AS REQUIRED, YOUR PATH MAY DIFFER)
  • Initiate a new venv env using the following terminal command: python -m venv venv
  • Activate the venv env using the following terminal command: venv\scripts\activate
  • Inside your IDE, create a new file inside your neo_dolfin folder called: .env (MAKE SURE TO INCLUDE THE "." AT THE BEGINNING)
    • Ask one of the team leads for the credentials, that you must paste into the .env file and then save the file.
  • Install the required libraries into the venv env using the following terminal command: pip install -r requirements.txt
  • To run the flask application, use the following terminal command: python app.py
  • Navigate to 127.0.0.1 in your web browser.

We have testing scripts enabled for this application.

• Make sure to install the pytest-flask module, it is currently listed in the requirements.txt
• To run, follow the steps for local deployment, but instead of the python app.py command, please use the pytest command.

PLEASE RUN THE PYTEST AND ATTACH THE LOG TEXT/SCREENSHOT TO YOUR PULL REQUEST Warnings are OKAY, Fails will result in the PULL request not being reviewed.

WORK IN PROGRESS