Fetching contributors…
Cannot retrieve contributors at this time
108 lines (66 sloc) 4.15 KB
title description headerTitle layout weight
Getting Started
Deploying is very easy with WeDeploy. You can start hosting your project, building a database, or even authenticating users within a couple of minutes!



Getting Started

There are basically two ways to deploy your project. You can integrate with GitHub for continuous deployment or use the command line for instant deployment, as seen below:

instant deployment

Download the CLI

In your terminal, run this command:

curl -sL | bash

This will install our command-line interface which is a tool that will help you use the WeDeploy platform.

The command above will only work for Unix-like systems such as macOS or Linux. If you use Windows, you should download the Windows amd64 installer.

Deploy Instantly

Assuming you already have a project locally, now you just need to run:

we deploy

This will immediately start uploading your files. Once that's finished, WeDeploy will start building and deploying your application. In the end, you'll be able to see it online in any browser.

If you don't have a project ready to deploy, you can download this simple project and run the we deploy command inside that folder.

Notice that this command will create a random name for your project. If you want to specify a new name or choose an existing project, you just need to run:

we deploy -p myproject

Being able to deploy instantaneously is great, but sometimes you want to trigger a deploy every time a push is made to GitHub. If that's your case, check the Continuous Deployment section.

Automatic Code Detection

When you send a bunch of files to WeDeploy, we detect how you want us to build your source code.

If you are deploying a project using Node.js, Java, Ruby, or a Dockerfile, we will scan your project and build it according to your project's unique attributes. For example, if we find a package.json, we'll build that as a Node.js service.

In order to make sure we know where you want us to scan, we require that you place a wedeploy.json inside the folder of every service you want to deploy and simply declare an ID inside.

  "id": "myservice"

To learn more about using the wedeploy.json to configure your project's behavior, see our Configuring Deployments Page

Try it yourself

We have created a whole array of tutorials to teach you how to start using WeDeploy. Click on one of the links below that interests you and begin your journey towards deployment!

  • Hosting: Deploy static files like HTML, CSS, and JS.
  • Data: Deploy a to-do list app using our Data Service and JS.
  • Auth: Deploy an authentication app using our Auth Service and JS.
  • Email: Deploy an email-sending app using our Email Service and JS.
  • Java: Deploy an app using Java and Spring Boot.
  • Ruby: Deploy an app using Ruby and Sinatra.
  • Node.js: Deploy an app using Node.js and Express.
  • Liferay DXP Trial: Deploy a Liferay DXP instance.
  • Docker: Deploy a Docker container.

What's next?

Learn more about how to configure your deployments.