Skip to content

Commit d2c1222

Browse files
authored
Update README.md
1 parent 7049b54 commit d2c1222

1 file changed

Lines changed: 27 additions & 34 deletions

File tree

README.md

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,61 +2,54 @@
22

33
These steps will get this sample application running for you using DigitalOcean.
44

5-
**Note: Following these steps will result in charges for the use of DigitalOcean Droplets**
5+
**Note: Following these steps will result in charges for the use of DigitalOcean services**
66

77
## Requirements
88

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)
109
* You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new
1110

11+
## Forking the Sample App Source Code
1212

13-
## Installing App Sail ##
13+
To use all the features of App Platform, you need to be running against your own copy of this application. To make a copy, click the Fork button above and follow the on-screen instructions. In this case, you'll be forking this repo as a starting point for your own app (see [Github documentation](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) to learn more about forking repos.
1414

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
15+
After forking the repo, you should now be viewing this README in your own github org (e.g. `https://github.com/<your-org>/sample-python`)
2316

2417
## Deploying the App ##
2518

26-
sail push
19+
1. Visit https://cloud.digitalocean.com/apps (if you're not logged in, you may see an error message. Visit https://cloud.digitalocean.com/login directly and authenticate, then try again)
20+
1. Click "Launch App" or "Create App"
21+
1. Choose GitHub and authenticate with your GitHub credentials.
22+
1. Under Repository, choose this repository (e.g. `<your-org>/sample-python`)
23+
1. On the next two screens, leave all the defaults unchanged.
24+
1. Click "Launch App"
25+
1. You should see a "Building..." progress indicator. And you can click "Deployments"→"Details" to see more details of the build.
26+
1. It can currently take 5-6 minutes to build this app, so please be patient. Live build logs are coming soon to provide much more feedback during deployments.
27+
1. Once the build completes successfully, click the "Live App" link in the header and you should see your running application in a new tab
2728

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+
## Making Changes to Your App ##
2930

30-
Then it will ask how to configure the app.
31-
Answer the questions as follows:
31+
As long as you left the default Autodeploy option enabled when you first launched this app, you can now make code changes and see them automatically reflected in your live application. During these automatic deployments, your application will never pause or stop serving request because the App Platform offers zero-downtime deployments.
3232

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.
33+
Here's an example code change you can make for this app:
34+
1. Edit [server.py](server.py)
35+
1. Change `Hello!` into another greeting.
36+
1. Commit the change to master. Normally it's a better practice to create a new branch for your change and then merge that branch to master after review, but for this demo you can commit to master directly.
37+
1. Visit https://cloud.digitalocean.com/apps and navigate to your sample-python app.
38+
1. You should see a "Building..." progress indicator, just like above.
39+
1. Once the build completes successfully, click the "Live App" link in the header and you should see your updated application running. You may need to force refresh the page in your browser (e.g. using Shift+Reload).
4540

4641
## Learn More ##
4742

48-
You can learn more about App Sail and how to manage and update your application at https://www.digitalocean.com/docs/appsail/.
43+
You can learn more about the App Platform and how to manage and update your application at https://www.digitalocean.com/docs/apps/.
4944

5045

5146
## Deleting the App #
5247

5348
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
49+
1. Visit the Apps control panel at https://cloud.digitalocean.com/apps
5550
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.
51+
1. Choose "Settings"->"Destroy"
6052

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.**
53+
This will delete the app and destroy any underlying DigitalOcean resources
6254

55+
**Note: If you don't delete your app, charges for the use of DigitalOcean services will continue to accrue.**

0 commit comments

Comments
 (0)