/flask-ibmcloud-boilerplate

Flask Boilerplate for IBM Cloud

Primary LanguagePythonApache License 2.0Apache-2.0

Flask IBM Cloud Boilerplate

Python Flask app with the necessary HTML, CSS, Js

Prerequisites

You'll need the following:

1. Clone the sample app

Now you're ready to start working with the app. Clone the repo and change to the directory where the sample app is located.

git clone https://url
cd flask-ibmcloud-boilerplate/

Peruse the files in the flask-ibmcloud-boilerplate/ directory to familiarize yourself with the contents.

2. Run the app locally

Install the dependencies listed in the requirements.txt file to be able to run the app locally.

You can optionally use a virtual environment to avoid having these dependencies clash with those of other Python projects or your operating system.

pip install -r requirements.txt

Run the app.

python hello.py

View your app at: http://localhost:8000

3. Prepare the app for deployment

To deploy to IBM Cloud, it can be helpful to set up a manifest.yml file. One is provided for you with the sample. Take a moment to look at it.

The manifest.yml includes basic information about your app, such as the name, how much memory to allocate for each instance and the route. In this manifest.yml random-route: true generates a random route for your app to prevent your route from colliding with others. You can replace random-route: true with host: myChosenHostName, supplying a host name of your choice. Learn more...

applications:
- name: flask-ibmcloud-boilerplate
  random-route: true
  memory: 128M

4. Deploy the app

You can use the Cloud Foundry CLI to deploy apps.

Choose your API endpoint

cf api <API-endpoint>

Replace the API-endpoint in the command with an API endpoint from the following list.

URL Region
https://api.ng.bluemix.net US South
https://api.eu-de.bluemix.net Germany
https://api.eu-gb.bluemix.net United Kingdom
https://api.au-syd.bluemix.net Sydney

Login to your IBM Cloud account

cf login

From within the flask-ibmcloud-boilerplate/ directory push your app to IBM Cloud

cf push

This can take a minute. If there is an error in the deployment process you can use the command cf logs <Your-App-Name> --recent to troubleshoot.

When deployment completes you should see a message indicating that your app is running. View your app at the URL listed in the output of the push command. You can also issue the

cf apps

command to view your apps status and see the URL.

5. Changes

  1. Make any changes you want and re-deploy to IBM Cloud!
cf push

View your app at the URL listed in the output of the push command, for example, myUrl.mybluemix.net.