|
| 1 | +# Getting Started # |
| 2 | + |
| 3 | +These steps will get this sample application running for you using DigitalOcean. |
| 4 | + |
| 5 | +**Note: Following these steps will result in charges for the use of DigitalOcean Droplets** |
| 6 | + |
| 7 | +## Requirements |
| 8 | + |
| 9 | +* Docker must be [installed locally](https://docs.docker.com/install/) on your machine, unless you choose to build remotely via Github Actions (beyond the scope of this README) |
| 10 | +* You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new |
| 11 | + |
| 12 | + |
| 13 | +## Installing App Sail ## |
| 14 | + |
| 15 | +To install the App Sail CLI, visit https://cloud.digitalocean.com/appsail and choose to Create or Launch a new app. Follow the on-screen instructions for installing the CLI. |
| 16 | + |
| 17 | +## Downloading the Sample App Source Code |
| 18 | + |
| 19 | +To download the demo app run in your terminal: |
| 20 | + |
| 21 | + git clone https://github.com/digitalocean-appsail/sample-python.git |
| 22 | + cd sample-python |
| 23 | + |
| 24 | +## Deploying the App ## |
| 25 | + |
| 26 | + sail push |
| 27 | + |
| 28 | +It will ask for an auth key if you haven't used the sail CLI before. Retrieve it from [the auth page](https://cloud.digitalocean.com/appsail/auth). |
| 29 | + |
| 30 | +Then it will ask how to configure the app. |
| 31 | +Answer the questions as follows: |
| 32 | + |
| 33 | + ✓ Is this app already live (on App Sail)?: No |
| 34 | + ✓ Name this app : sample-python |
| 35 | + ✓ Need to set any env variables: No |
| 36 | + Let's configure your app for deployment: |
| 37 | + ✓ Choose your configuration preference: Automatic... |
| 38 | + ✓ Python app detected, is this correct: Yes |
| 39 | + ✓ What is the command to start your app: python *.py |
| 40 | + ✓ Do you need any background workers: No |
| 41 | + ✓ Do you need a database: No |
| 42 | + |
| 43 | + |
| 44 | +After that, it will go through a deploy process. Once it's done, you can open the live app or administration dashboard by following the links provided by the App Sail CLI once the push is completed. |
| 45 | + |
| 46 | +## Learn More ## |
| 47 | + |
| 48 | +You can learn more about App Sail and how to manage and update your application at https://www.digitalocean.com/docs/appsail/. |
| 49 | + |
| 50 | + |
| 51 | +## Deleting the App # |
| 52 | + |
| 53 | +When you no longer need this sample application running live, you can delete it by following these steps: |
| 54 | +1. Visit the app dashboard at https://cloud.digitalocean.com/appsail |
| 55 | +1. Navigate to the sample-python app |
| 56 | +1. Choose "App Config"->"Show More" |
| 57 | +1. Select "Delete", type your app's name, and click "Delete App". |
| 58 | + |
| 59 | +This will delete the app and destroy any underlying DigitalOcean Droplets. |
| 60 | + |
| 61 | +**Note: If you don't delete your app, charges for the use of DigitalOcean Droplets will continue to accrue. Also, even if you delete your app, a new push to your sample-nodejs repo on Github will trigger a new deploy which will result in DigitalOcean charges.** |
| 62 | + |
0 commit comments