Update EAS.config

.env.example

@@ -1,3 +1,7 @@
+EXPO_APPLICATION_SERVICES_PROJECT_ID=""
+
 STA_API_BASE_URL=""
 STA_API_VERSION="v1"
+STA_API_KEY=""
+
 FEATURES_ENABLED=events,profileScreen

DEPLOYMENT.md

@@ -67,6 +67,8 @@ There are also settings in the main Expo config file `app.config.ts` -- look for
 
    > If you aren't already logged into Expo Application Services (EAS), you'll be asked to login. Ask another team member for the STA's Expo Application Services login details.
 
+   > If you get a message saying _EAS project not configured. Existing EAS project found for @scottishtecharmy/volunteer-app Configure this project?_ Stop the build process. You need to add `EXPO_APPLICATION_SERVICES_PROJECT_ID` to your `.env` file. Ask another team member for the value of this variable.
+
    > If you get an error saying `Error reading Expo config ... Cannot find module 'dotenv/config'` you may need to reinstall the `dotenv` package. In the `app` directory run `npx expo install dotenv` (if that doesn't fix it try `npm install dotenv`) (If you get warnings, but not errors, when reinstalling this package - don't worry.)
 
    > Builds can take some time (sometimes 10-20 minutes, sometimes more than an hour, depending on how busy EAS servers are), but you can check the exact status of a build and the different steps that are taking place in the Expo Application Services dashboard -- follow the URL you'll see in your terminal after you run one of the build commands below (ask another team member for the Expo Application Services login details). You can also see there if there are any errors.

GITFLOW.md

@@ -0,0 +1,71 @@
+# Git Flow
+The team uses Git Flow to to develop the application and it's API. For more detail, have a look at Atlassian's [Git Flow documentation](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) or for a good synopsis [Daniel Kummer's cheatsheat](https://danielkummer.github.io/git-flow-cheatsheet/)
+
+## Installing
+
+### Mac
+`brew install git-flow-avh`
+
+### Linux
+`apt-get install git-flow-avh`
+
+### Windows
+Git for Windows has supported Git Flow from version 2.5.3
+
+## Overview
+Git Flow uses two permanent branches - main and develop:
+- main is production
+- develop is the working branch
+
+There are some other, temporary, branches:
+- hotfix for security patches
+- feature to add functionality
+- release where we decide which features to release
+
+Most of the time you'll be creating feature branches, having them reviewed, and merging into develop.
+
+## This is complicated why am I doing this?
+Some features are not ready for production but are needed to develop other functions. For example login screens are needed to develop and test login logic but we don't want them in production yet.
+
+Git Flow gives us the flexibility to continue developing as a team but picking and choosing which features hit production.
+
+## Right I'm convinced so how do I do it?
+Whatever you're doing the sequence is the same - start and push. Remember to replace JIRA-TICKET with the JIRA ticket you're working on, or a descriptive name if its not in Jira for whatever reason.
+
+## Switching to Git Flow
+*** You must complete this step ***
+After cloning the repository or from your existing local repository enter `git flow init`. This asks a series of questions, accept all the default values, and configures your local `.gitconfig` file. This file is not uploaded to GitHub so only affects local installs.
+
+You only need to complete this step the first time you clone a repository or when you first start using Git Flow in a project. You will have to do it for each computer you work on, unless you have some funky home directory syncing going on.
+
+### Create a new feature
+1. `git flow feature start SVA-999-my-jira-ticket` (where 999 is your ticket number) creates a new `feature` branch from `develop` and switches to it.
+2. Once you're done then `git flow feature publish`.
+3. Create a pull request as usual, which still requires two reviewers, what has changed is that we're now merging with `develop` and not `main`. 
+4. Once your PR is merged `git flow feature finish` will ensure that your feature is merged with your local `develop` branch and removes the `feature` branch.
+
+### Bugfix
+The process is the same, except the command changes from feature to hotfix `git flow bugfix start bug_number`
+1. `git flow bugfix start bug_number` creates a new `feature` branch from `develop` and switches to it.
+2. Once you're done then `git flow bugfix publish`.
+3. Create a pull request as usual, which still requires two reviewers, this will merge to `main` and `develop`. 
+4. Once your PR is merged `git flow bugfix finish` will ensure that your feature is merged with `main` and `develop`, then removes the `bugfix` branch.
+
+### Release
+The process is the same, except the command changes from feature to hotfix `git flow bugfix start bug_number`
+1. `git flow release start mvp-X` (where X is the MVP number) creates a new `feature` branch from `develop` and switches to it.
+2. Once you're done then `git flow release publish`.
+3. Create a pull request as usual, which still requires two reviewers, this will merge to `main`. 
+4. Once your PR is merged `git flow release finish` will ensure that your feature is merged with `main` then removes the `release` branch.
+
+## Caveat
+When merging remember to squash and merge, especially on main, to make it clear what feature was merged.
+
+Ensure when creating or reviewing PR that the branches are as you expect:
+- `feature` merge to `develop`
+- `bugfix` merge to `main` and `develop`
+- `release` merge to `main` and `develop`
+
+If in doubt reach out to the team on the Slack #volunteer-app channel!
+
+*** This is new and you aren't expected to know it, we expect questions! ***

PULL_REQUEST_TEMPLATE.md

@@ -2,13 +2,14 @@
   - [Type of change](#type-of-change)
 - [Testing locally](#testing-locally)
 - [Checklist](#checklist)
+- [Deployment](#deployment)
 
 # Description
 
 - Please include a summary of the change and which issue is fixed.
 - List any dependencies that are required for this change.
 
-Fixes # (issue number)
+Fixes # [SVA issue number]
 
 ## Type of change
 
@@ -26,15 +27,20 @@ Please delete options that are not relevant
 
 # Checklist
 
-- [] My code follows the style guidelines of this project
-- [] I have performed a self-review of my own code
-- [] I have commented my code, particularly in hard-to-understand areas
-- [] I have removed any unnecessary comments or console logging
-- [] I have made corresponding changes to the documentation (if required)
-- [] I have addressed accessibility, if needed
-- [] I have followed best practices, e.g. NativeBase approaches and theming
-- [] I have checked the app in dark mode, if making front-end design changes
 - [] My changes generate no new warnings
-- [] I have added tests that prove my fix is effective or that my feature works
+- [] I have performed a self-review of my own code
+- [] I have added JSDocs where required and commented my code in hard-to-understand areas
+- [] My code does not contain any unnecessary console logging
+- [] I have made changes to the documentation if required / My code doesn't need documentation updates
+- [] I have added tests that prove my code is effective or that my feature works
 - [] New and existing unit tests pass locally with my changes
-- [] I have updated the version numbers in `package.json` files in the [app](DEPLOYMENT.md#app-deployment) and/or [api](DEPLOYMENT.md#api-deployment-on-aws) directories as needed
+
+If making front-end design changes:
+
+- [] I have followed best accessibility practices
+- [] I have followed best practices for this project, e.g. NativeBase approaches and theming
+- [] I have checked the app in dark mode
+
+# Deployment
+
+If you want to deploy these changes, follow the steps in [DEPLOYMENT.md](https://github.com/Scottish-Tech-Army/Volunteer-app/blob/main/DEPLOYMENT.md)

README.md

@@ -86,6 +86,12 @@ If you're using Visual Studio Code for development, it's recommended that you:
 - Install the [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
 - [Enable formatting on save](https://scottsauber.com/2017/06/10/prettier-format-on-save-never-worry-about-formatting-javascript-again/). Combined with ESLint and Prettier, this takes care of some code style issues such as formatting, indentation and semicolon consistency for you automatically.
 
+## Git Flow
+
+**_ Make sure that you are familiar with Git Flow before starting! _**
+
+The Team use Git Flow to manage development and release versions, follow the [Git Flow setup steps first](GITFLOW.md).
+
 # Setup and first run
 
 1. Ensure that you've gone through the setup instructions above
@@ -94,19 +100,25 @@ If you're using Visual Studio Code for development, it's recommended that you:
 
    > Using SSH do `git clone [email protected]:Scottish-Tech-Army/Volunteer-app.git` or using https do `git clone https://github.com/Scottish-Tech-Army/Volunteer-app.git`
 
-3. Follow the instructions in [`Volunteer-api`](https://github.com/Scottish-Tech-Army/Volunteer-api) repo to run the api locally
+3. Open your terminal and in the new `Volunteer-app` directory type `git flow init` to initialise Git Flow (see [Git Flow](GITFLOW.md)).
+
+4. Follow the instructions in [`Volunteer-api`](https://github.com/Scottish-Tech-Army/Volunteer-api) repo to run the api locally
+
+5. At the command prompt type `npx expo install`
 
-4. At the command prompt type `npx expo install`
+   > Inside the `app` folder there are files `package.json` and `package-lock.json`. **Every time either of these is modified, it is advised to repeat this step before running the project.**
 
-   > Each time you pull from GitHub it is best to run this step in case `package.json` changed
+   > **If you get _warnings_ about installing dependencies** you probably don't worry about these
 
-   > **If you get _warnings_ about installing dependencies** you probably don't worry about these, but do raise them as they indicate possible compatibility issues in dependencies
+   > **If you get _errors_ about installing dependencies** try running `npx expo install` and then `npm install --legacy-peer-deps` or `npm install --force`.
 
-   > **If you get _errors_ about installing dependencies** try running `npx expo install` again then ask for help in slack
+6. Copy the `.env.example` file in the api root folder and name your new file `.env` in the same folder -- e.g. using the command `cp .env.example .env` Set the value of `STA_API_BASE_URL` to the tunnelled URL of your local API server (the one you made a note of in step 8 above).
 
-5. Copy the `.env.example` file in the api root folder and name your new file `.env` in the same folder -- e.g. using the command `cp .env.example .env` Set the value of `STA_API_BASE_URL` to the tunnelled URL of your local API server (the one you made a note of in step 8 above).
+7. Ask on Slack for a member of the team to send you the value to use for `EXPO_APPLICATION_SERVICES_PROJECT_ID`.
 
-6. Run Expo using `npm start` This will run some commands and then it show you a QR code in your terminal.
+   > For security reasons, the `EXPO_APPLICATION_SERVICES_PROJECT_ID` value is not stored in this repo.
+
+8. Run Expo using `npm start` This will run some commands and then it show you a QR code in your terminal.
 
 > You may get an automatic prompt to install `@expo/ngrok` or another package -- if so, type `y` to install it.
 
@@ -144,6 +156,8 @@ Below are some commonly encountered issues and possible ways to resolve them. If
 
   > Make sure the API is running on your local machine, and that your **.env** files are configured correctly (see [Setup and first run](#setup-and-first-run) above)
 
+  > Make sure the API is running on your local machine, and that your **.env** files are configured correctly (see [Setup and first run](#setup-and-first-run) above)
+
   > Check the values for both `API_TUNNEL_SUBDOMAIN` and `STA_API_BASE_URL`. `STA_API_BASE_URL` should be prefixed with `https://`. `API_TUNNEL_SUBDOMAIN` should _not_ be prefixed with `https://` and should _only_ include the URL up to but **not** including `.loca.lt`.
 
   -     STA_API_BASE_URL="https://nadia-bloggs-abc123def456ghi789.loca.lt"
@@ -176,8 +190,6 @@ Below are some commonly encountered issues and possible ways to resolve them. If
 
 2. In a third terminal window, enter `npm start` to run Expo
 
-3. Connect your phone to your local development version of the app in Expo Go:
-
 - **iPhone:** open the camera and scan the QR code, this should open up the app in Expo Go
 - **Android:** open the Expo Go app itself and you can scan the QR code
   > If you find you're not seeing changes on your phone or Expo Go loses the connection, [see tips here.](APP_DEVELOPMENT.md#expo-known-issues)

app.config.ts

@@ -66,7 +66,9 @@ module.exports = {
         apiKey: process.env.BUGSNAG_API_KEY,
       },
       eas: {
-        projectId: '9cd93ab4-ee33-43d1-a995-e4f8531553e2',
+        projectId:
+          process.env.EXPO_APPLICATION_SERVICES_PROJECT_ID ??
+          '9cd93ab4-ee33-43d1-a995-e4f8531553e2',
       },
     },
     hooks: {

eas.json

@@ -1,23 +1,21 @@
 {
   "cli": {
-    "appVersionSource": "remote",
-    "version": ">= 3.13.3"
+    "version": ">= 5.9.3",
+    "appVersionSource": "remote"
   },
   "build": {
+    "development": {
+      "developmentClient": true,
+      "distribution": "internal"
+    },
+    "preview": {
+      "distribution": "internal"
+    },
     "production": {
-      "distribution": "store",
       "autoIncrement": true
     }
   },
   "submit": {
-    "production": {
-      "android": {
-        "track": "internal"
-      },
-      "ios": {
-        "ascAppId": "1632619020",
-        "appleTeamId": "48N3J4V5KM"
-      }
-    }
+    "production": {}
   }
 }