-
Notifications
You must be signed in to change notification settings - Fork 344
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from digitalocean/readme-edits
Readme edits
- Loading branch information
Showing
1 changed file
with
26 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,56 @@ | ||
| # Getting Started | ||
| ## Getting Started | ||
|
|
||
| These steps will get this sample Python application running for you using DigitalOcean App Platform. | ||
| We provide a sample app using Python that you can deploy on App Platform. These steps will get this sample application running for you using App Platform. | ||
|
|
||
| **Note: Following these steps may result in charges for the use of DigitalOcean services** | ||
| **Note: Following these steps may result in charges for the use of DigitalOcean services.** | ||
|
|
||
| ## Requirements | ||
| ### Requirements | ||
|
|
||
| * You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new. | ||
|
|
||
| * You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new | ||
|
|
||
| ## Deploying the App | ||
|
|
||
| Click this button to deploy the app to the DigitalOcean App Platform. If you are not logged in, you will be prompted to log in with your DigitalOcean account. | ||
|
|
||
| [](https://cloud.digitalocean.com/apps/new?repo=https://github.com/digitalocean/sample-python/tree/main) | ||
|
|
||
| Using this button disable the "Auto deploy changes on push" feature as you are using this repo directly. If you wish to try that feature, you will need to make your own copy of this repository. | ||
| Using this button disables the ability to automatically re-deploy your app when pushing to a branch or tag in your repository as you are using this repo directly. | ||
|
|
||
| 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. | ||
| If you want to automatically re-deploy your app, [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the GitHub repository to your account so that you have a copy of it stored to the cloud. Click the **Fork** button in the GitHub repository and follow the on-screen instructions. | ||
|
|
||
| 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`). To deploy the new repo, visit https://cloud.digitalocean.com/apps and click "Create App" or "Launch Your App". Then, select the repository you created and be sure to select the `main` branch. | ||
| 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`). To deploy the new repo, visit https://cloud.digitalocean.com/apps and click **Create App**. Then, click **GitHub**, select the repository you created and select the `main` branch. App Platform will inspect the code, automatically detect the kind of component to create, and use the correct buildpack to create and deploy a container. | ||
|
|
||
| After clicking the "Deploy to DigitalOcean" button or completing the instructions above to fork the repo, follow these steps: | ||
| After clicking the **Deploy to DigitalOcean** button or completing the instructions above to fork the repo, follow these steps: | ||
|
|
||
| 1. Select which region you wish to deploy your app to and click Next. The closest region to you should be selected by default. All App Platform apps are routed through a global CDN so this will not affect your app performance, unless it needs to talk to external services. | ||
| 1. On the following screen, leave all the fields as they are and click Next. | ||
| 1. Confirm your Plan settings and how many containers you want to launch and click **Launch Basic/Pro App**. | ||
| 1. You should see a "Building..." progress indicator. And you can click "Deployments"→"Details" to see more details of the build. | ||
| 1. It can take a few minutes for the build to finish, but you can follow the progress by clicking the "Details" link in the top banner. | ||
| 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, displaying the home page. | ||
| 1. Configure the app such as specifying HTTP routes, environment variables or adding a database. | ||
| 1. Provide a name for your app and select which region you want to deploy your app to and click **Next**. The closest region to you should be selected by default. All App Platform apps are routed through a global CDN. So this will not affect your app performance, unless it needs to talk to external services. | ||
| 1. On the following screen, leave all the fields as they are and click **Next**. | ||
| 1. Confirm your **Plan** settings and how many containers you want to launch and click **Launch Basic/Pro App**. | ||
| 1. You should see a "Building..." progress indicator. You can click **View Logs** to see more details of the build. | ||
| 1. It can take a few minutes for the build to finish, but you can follow the progress in the **Deployments** tab. | ||
| 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, displaying the home page. | ||
|
|
||
| ## Making Changes to Your App | ||
| ### Making Changes to Your App | ||
|
|
||
| If you followed the steps above to fork the repo and used your own copy when deploying the app, you can enjoy automatic deploys whenever changes are made to the repo. During these automatic deployments, your application will never pause or stop serving request because App Platform offers zero-downtime deployments. | ||
| If you followed the steps to fork the repo and used your own copy when deploying the app, you can push changes to your fork and see App Platform automatically re-deploy the update to your app. During these automatic deployments, your application will never pause or stop serving request because App Platform offers zero-downtime deployments. | ||
|
|
||
| Here's an example code change you can make for this app: | ||
|
|
||
| 1. Edit `server.py` and replace "Hello!" on line 12 with a different greeting | ||
| 1. Edit `index.php` and replace "Hello!" on line 12 with a different greeting | ||
| 1. Commit the change to the `main` branch. Normally it's a better practice to create a new branch for your change and then merge that branch to `main` after review, but for this demo you can commit to the `main` branch directly. | ||
| 1. Visit https://cloud.digitalocean.com/apps and navigate to your sample app. | ||
| 1. You should see a "Building..." progress indicator, just like when you first created the app. | ||
| 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). | ||
| 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**). | ||
|
|
||
| ## Learn More | ||
| ### Learn More | ||
|
|
||
| You can learn more about the App Platform and how to manage and update your application at https://www.digitalocean.com/docs/app-platform/. | ||
|
|
||
| ## Deleting the App | ||
|
|
||
| When you no longer need this sample application running live, you can delete it by following these steps: | ||
| 1. Visit the Apps control panel at https://cloud.digitalocean.com/apps | ||
| 1. Navigate to the sample app | ||
| 1. Choose "Settings"->"Destroy" | ||
| 1. Visit the Apps control panel at https://cloud.digitalocean.com/apps. | ||
| 2. Navigate to the sample app. | ||
| 3. In the **Settings** tab, click **Destroy**. | ||
|
|
||
| **Note: If you don't delete your app, charges for the use of DigitalOcean services will continue to accrue.** | ||
| **Note: If you do not delete your app, charges for using DigitalOcean services will continue to accrue.** |