alysonv3

Get started
- iOS
- Android
- Web
Notes
FAQs
Troubleshooting
Running in Up mode as part of the full Genny Project stack

Get started

iOS

Install JS dependencies

npm install

Install iOS dependencies

Note: you will need Cocoapods installed on your machine

cd ios && pod install

Run the packager

cd .. && npm run start:native

place your environment variables into a .env file in the root of the project, or place them into a .env.project-name file
Open XCode
Build the project
If using a simulator, run the project under the selected simulator in XCode
If using a device, run the project under the selected device in XCode
If using an environment variable file that is not .env, run

ENVFILE=.env.project-name react-native run-ios

Android

Install JS dependencies

npm install

Run the packager

cd .. && npm run start:native

Open the /android folder as a project in Android Studio.
Start the simulator in Android Studio, then run

react-native run-android

if using an environment variable file that is not .env, use

ENVFILE=.env.project-name  react-native run-android

Web

Install JS dependencies

npm install

Run the web app

npm run start:web

Open http://localhost:3000/

Notes

Do not run npm link! Always only use npm link {library_name}.

- npm link
+ npm link {library_name}

If you do run npm link across the project, you will break many other libraries. These other libraries need installations more complex than npm link command can offer, and in running that command you are breaking their complex installations. It is tricky to reverse the effects of running this command, so we recommend you simply reset your project files.

FAQs

How do I set environment variables?

By default, all the config values are fetched from Bridge and used from thereon in. On web, the Bridge URL is assumed to be accessible from the same URL which the web app is hosted on, and therefore no extra guidance from you needs to be given for the web app to point to the correct Bridge URL.

However, sometimes you may need to change what the Bridge URL should be. A good example of this is when you're developing locally, and trying to point to the staging Bridge URL. You need to override the environment variable ENV_GENNY_BRIDGE_URL and set it to the relevant app's Bridge URL.

You can easily override any environment variables by either passing them in when you run npm run start:web.

To do so, simply follow this convention:

- --env.{key}={value}
+ --env.ENV_GENNY_BRIDGE_URL=http://www.google.com.au

So your run command may end up looking like this:

npm run start:web -- --env.VAR_ONE=one --env.VAR_TWO=two

Alternatively, you can also set up a .env file containing these environmental variables to save you from passing them in via the CLI every time you run the web app.

To do so, follow these steps:

Create a file named .env in the root directory of this project
Open the .env file and write your environment variables inside, like so:

ENV_GENNY_BRIDGE_URL=https://www.google.com.au
ENV_LAYOUT_PUBLICURL=http://localhost:2224
ENV_LAYOUT_QUERY_DIRECTORY=layouts/example-directory

Run the web app again

npm run start:web

Open http://localhost:3000/

Troubleshooting

Copy Plist File Error (iOS)

/PROJECT_PATH/alyson-v3/ios/alysonv3/AppCenter-Config.plist:0: error: reading data: The file “AppCenter-Config.plist” couldn’t be opened because there is no such file.

To fix this error, run the following command:

ENVFILE=.env npm run setup-files

Running in Up mode as part of the full Genny Project stack

Git pull the following projects:

   alyson-v3
   layout-cache

Create an .env file in the alyson-v3 project. It should contain the following properties:

	APP_NAME=<Project>
	APP_ID=<project>
	GENNY_HOST=http://bridge.genny.life
	GENNY_INITURL=http://alyson3.genny.life
	GENNY_BRIDGE_PORT=80
	GENNY_BRIDGE_VERTEX=frontend
	GENNY_BRIDGE_SERVICE=api/service
	GENNY_BRIDGE_EVENTS=api/events
	UPPY_URL=""
	KEYCLOAK_REDIRECTURI=http://keycloak.genny.life
	APPCENTER_ANDROID_SECRET=xxx
	APPCENTER_IOS_SECRET=xxx
	CODEPUSH_KEY=xxx
	LAYOUT_PUBLICURL=http://localhost:2224/
	LAYOUT_QUERY_DIRECTORY=layouts/<project>-new
	GUEST_USERNAME=guest
	GUEST_PASSWORD=asdf1234
	GOOGLE_MAPS_APIKEY=<GoogleMapKey>
	GOOGLE_MAPS_APIURL=https://maps.googleapis.com/maps/api/js

In alyson-v3 project, run the command ./build-docker.sh

In genny-main project, copy the following service in docker-compose.yml:

  	alyson-v3:
    		image: gennyproject/alyson-v3:latest
    		container_name: alyson-v3
    		depends_on:
     		     - bridge
    		ports:
    		     - "6000:8080"
    		environment:
   		     - REACT_BRIDGE_HOST=http://bridge.genny.life
    		     - NODE_ENV=production
    		env_file:
   	                 - ${ENV_FILE}
   		 networks:
      		     - mainproxy
    		restart: always

In layout-cache project, run the command ./build-docker.sh followed by ./start-dev.sh. The response should be as below:

	Starting layout-cache_layout-cache_1 ... done
	Attaching to layout-cache_layout-cache_1
	layout-cache_1  |
	layout-cache_1  | > layout-cache@1.0.0 start /usr/src/app
	layout-cache_1  | > node index.js
	layout-cache_1  |
	layout-cache_1  | Layout cache listening on port 2223!
	layout-cache_1  | Layout cache public server listening on port 2224!

In genny-main project, run the command

./run.sh <project> up

Finally, launch the browser and run the following URL: http://alyson3.genny.life

genny-project/alyson-v3