Skip to content
This repository was archived by the owner on May 9, 2025. It is now read-only.

Commit 186b783

Browse files
author
Kamal Nasser
authored
Merge pull request #5 from digitalocean/readme-updates-20210109
Update README.md
2 parents 44036dd + 3759b74 commit 186b783

File tree

1 file changed

+32
-21
lines changed

1 file changed

+32
-21
lines changed

README.md

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,55 @@
1-
# Getting Started #
1+
# Getting Started
22

3-
These steps will get this sample application running for you using DigitalOcean.
3+
These steps will get this sample Vue.js application running for you using DigitalOcean App Platform.
44

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

77
## Requirements
88

99
* You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new
1010

11-
## Forking the Sample App Source Code
11+
## Deploying the App
1212

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.
13+
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.
1414

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-vuejs`)
15+
[![Deploy to DigitalOcean](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/digitalocean/sample-vuejs/tree/main)
1616

17-
**Note:** You can skip forking this repo and select the "Vue.js" sample from the app creation page, however do notice that certain features will be disabled.
17+
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.
1818

19-
## Deploying the App ##
19+
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.
2020

21-
Click this button to deploy the app to the DigitalOcean App Platform.
21+
After forking the repo, you should now be viewing this README in your own github org (e.g. `https://github.com/<your-org>/sample-vuejs`). 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.
2222

23-
[![Deploy to DO](https://mp-assets1.sfo2.digitaloceanspaces.com/deploy-to-do/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/digitalocean/sample-vuejs/tree/main)
24-
25-
## Making Changes to Your App ##
23+
After clicking the "Deploy to DigitalOcean" button or completing the instructions above to fork the repo, follow these steps:
2624

27-
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.
25+
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.
26+
1. On the following screen, leave all the fields as they are and click Next.
27+
1. Confirm your Plan settings and how many containers you want to launch and click **Launch Basic/Pro App**.
28+
1. You should see a "Building..." progress indicator. And you can click "Deployments"→"Details" to see more details of the build.
29+
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.
30+
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.
2831

29-
## Learn More ##
32+
## Making Changes to Your App
3033

31-
You can learn more about the App Platform and how to manage and update your application at https://www.digitalocean.com/docs/apps/.
34+
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.
3235

36+
Here's an example code change you can make for this app:
3337

34-
## Deleting the App #
38+
1. Edit `src/App.vue` and replace "Welcome to Your Vue App" with a different greeting
39+
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.
40+
1. Visit https://cloud.digitalocean.com/apps and navigate to your sample app.
41+
1. You should see a "Building..." progress indicator, just like when you first created the app.
42+
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).
43+
44+
## Learn More
45+
46+
You can learn more about the App Platform and how to manage and update your application at https://www.digitalocean.com/docs/app-platform/.
47+
48+
## Deleting the App
3549

3650
When you no longer need this sample application running live, you can delete it by following these steps:
3751
1. Visit the Apps control panel at https://cloud.digitalocean.com/apps
38-
1. Navigate to the sample-vuejs app
52+
1. Navigate to the sample app
3953
1. Choose "Settings"->"Destroy"
4054

41-
This will delete the app and destroy any underlying DigitalOcean resources
42-
43-
**Note: If you don't delete your app, charges for the use of DigitalOcean services will continue to accrue.**
44-
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)