Sample App for Node.js

App Platform is a Platform-as-a-Service (PaaS) offering that allows developers to publish code directly to DigitalOcean servers without worrying about the underlying infrastructure.

---

The NodeJS buildpack applies to this sample app. See the NodeJS buildpack overview for more information about its configuration options and limitations.

This content is automatically generated from https://github.com/digitalocean/sample-nodejs/blob/main/README.md.

Getting Started

We provide a sample app using Node.js 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.

Requirements

• 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.

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.

If you want to automatically re-deploy your app, fork 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-nodejs). 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:

1. Configure the app such as specifying HTTP routes, environment variables or adding a database.
2. 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.
3. On the following screen, leave all the fields as they are and click Next.
4. Confirm your Plan settings and how many containers you want to launch and click Launch Basic/Pro App.
5. You should see a “Building…” progress indicator. You can click View Logs to see more details of the build.
6. It can take a few minutes for the build to finish, but you can follow the progress in the Deployments tab.
7. 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

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 code within the repository
2. 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.
3. Visit https://cloud.digitalocean.com/apps and navigate to your sample app.
4. You should see a “Building…” progress indicator, just like when you first created the app.
5. 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

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.
2. Navigate to the sample app.
3. In the Settings tab, click Destroy.

Note: If you do not delete your app, charges for using DigitalOcean services will continue to accrue.

Limits

• Both the npm and Yarn package managers are supported. However, you must commit either package-lock.json for npm projects or yarn.lock for Yarn projects to the repo alongside the app’s source code.