-
-- -This will bring you to the App Dashboard, from this screen you can continue the setup of the demo app for deployment. - -- App Checklist: Complete Steps 6-9 to prepare the app for deployment - - Step 6: Deploy the App to the Production Environment - Add the Production URL - - Step 7: Verify Domain Ownership - Add the string supplied in this step to your .env file. This is deailed in step 4 of this list. - - Step 8: Process a transaction - Visit your app in the Pi Browser and complete a payment - -
-- -- App Configuration: Additional information that can be adjusted - - Whitelisted usernames: you can leave this blank at this point - - Hosting type: select "Self hosted" - - App URL: Enter the intended production URL of your app (e.g "https://mydemoapp.com"), - or simply set it up to an example value (e.g "https://example.com"). This must be an HTTPs URL. - - Development URL: This is irrelevant for deployment. - - -### 4. Set up environment variables (1/3) - -Create a .env config file in order to enable docker-compose to pick up your environmnent variables: - -```shell -# Move to the app's directory: -cd platform-demo-app - -# Create .env from the starter template: -cp .env.example .env - -# Edit the resulting file: -vi .env -# or: -nano .env -``` - -Set up the following environment variables. Using the example above: - -``` -FRONTEND_URL=https://mydemoapp.com -FRONTEND_DOMAIN_NAME=mydemoapp.com -BACKEND_URL=https://backend.mydemoapp.com -BACKEND_DOMAIN_NAME=backend.mydemoapp.com -``` - - -### 5. Set up environment variables (2/3) - -Obtain the following values from the developer portal: - -**Domain Verification Key**: Go to the developer portal, and on your list of registered apps click on the app you are verifying. Next click on the "App Checklist" and click on step 7. From this page you can obtain the string that needs added to your `.env` file. - -
-
-**API key**: obtained by tapping the "API Key" button on the App Dashboard
-
-
-
-Then, copy-paste those values in the following two keys of your .env file:
-
-```
-# Add your Domain Validation Key here:
-DOMAIN_VALIDATION_KEY=
-
-# Add your API key here:
-PI_API_KEY=
-```
-
-
-### 6. Set up environment variables (3/3)
-
-Configure the following environment variables:
-
-```
-# Generate a secure password for your MongoDB database and paste it here:
-MONGODB_PASSWORD=
-
-# Generate a random string (e.g 64 alphanumeric characters) and paste it here:
-SESSION_SECRET=
-```
-
-
-### 7. Run the docker containers:
-
-**Make sure you are in the `platform-demo-app` directory before running any `docker-compose` command!**
-
-```
-docker-compose build
-docker-compose up -d
-```
-
-You can check which containers are running using either one of the following two commands:
-
-```
-docker ps
-docker-compose ps
-```
-
-
-You can print out logs of the Docker containers using the following command:
-
-```
-docker-compose logs -f
-
-- -This will bring you to the App Dashboard, from this screen you can continue the development of the demo app. - -- App Checklist: Complete Steps 1-5 to prepare the app for launch in development mode - - Step 1: "Register an App" was completed previously - - Step 2: Configure App Hosting - Hosting type: select "Self hosted" - - Step 3: Create a Pi Wallet, see this [Pi Wallet Introduction](https://pi-apps.github.io/community-developer-guide/docs/importantTopics/paymentFlow/piWallet/) for more information - - Step 4: Review this documentation and our [Community Developer Guide](https://pi-apps.github.io/community-developer-guide/) for help getting setup - - Step 5: Configure App Development URL: the URL on which your app is running on your development environment. If your using the default - setup for the demo app frontend, this is "http://localhost:3314. **Note:** If you need, you can change the port by specifying it in - `frontend/.env` file, as the value of the `PORT` environment variable. - -
-
- - -- App Configuration: Additional information that can be adjusted - - Whitelisted usernames: you can leave this blank at this point - - App URL: This is irrelevant for development. You can use the intended production URL of your app (e.g "https://mydemoapp.com"), - or simply set it up to an example value (e.g "https://example.com"). This must be an HTTPs URL - - Development URL: The URL on which your app is running on your development environment. If your using the default - setup for the demo - -## 3. Run the frontend development server - -Setup the frontend app following the [Pi Demo App Frontend documentation](../frontend/README.md). - - -## 4. Run the backend development server - -Setup backend server following the [Pi Demo App Backend documentation](../backend/README.md). - -## 5. Open the app in the Sandbox - -To test all of the Demo App features, you need to run it in the Pi Sandbox. - -The purpose of the Sandbox is to enable running and debugging a Pi App in a desktop browser, although a Pi App -is meant to be opened in the Pi Browser by end-users. - -For more information on the Sandbox head to our [Community Developer Guide](https://pi-apps.github.io/community-developer-guide/docs/gettingStarted/piAppPlatform/piAppPlatformSDK/#the-sandbox-flag). - -Lastly, **on your desktop browser** open the sandbox URL from Step 6 of App Checklist: - - - - - -> **WARNING** -> -> The demo app uses express session cookies which, in the Sandbox environment, are not correctly saved on the client on some browsers. -> To properly test all of the features of the Demo App, we recommend you to open the sandbox app using Mozilla Firefox. - -#### Congratulations! The app should work in the developer portal and enable you to sign in, place an order and make a testnet payment. - -# More Information - Developing on Pi -For guidelines on how to register an app and get the Sandbox URL, please refer to the -[Pi Developer Guide](https://pi-apps.github.io/community-developer-guide/). diff --git a/doc/img/api_key.png b/doc/img/api_key.png deleted file mode 100644 index 5019167afb9620a6c7af721744eac981dade7260..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 38455 zcmc$_WmsK1(=ZH_BE{X^-QA_Q6)5gn95${ScXyX!rMSDhTZ?OPmyPR7@B8$e^F7z| z{dxbqdtd8H)?_A=nM@|h$|OulK@#Bu?gub1Fa&8Sab++t@XNO+7zXMM;!FAt`t8Np zLQG7_N=#DB&e{&3VsB_{DsJIuZ*AzV#0CaN9p@a|F59bw-mh4yJjEM|NPy28CiY|I zgNwr#I`ogss_#ox(tTiUyvS*k9njQi?uazHHSMcHRqY+@k;S1=Rx^2Nn!dQLrKm2E zt_|)yb7wj>>vZ8M;n3YcP#+}6$@LY~|7h9v3<$|q`EFM8?JNC
S8KC>cP-dVmbwqcz994Ab8fxz>af|jl