Setup
Back to home
On this page
Got code?
In order to follow along with this guide, you need a local project. While the guide has been written to accommodate the following stacks, it is not limited to just those listed and are here only as examples.
JavaScript/Node.js
Before you begin 
You need:
- Git. Git is the primary tool to manage everything your app needs to run. Push commits to deploy changes and control configuration through YAML files. These files describe your infrastructure, making it transparent and version-controlled.
- A Upsun account. If you don’t already have one, register for a trial account. You can sign up with an email address or an existing GitHub, Bitbucket, or Google account. If you choose one of these accounts, you can set a password for your Upsun account later.
- The Upsun CLI. This lets you interact with your project from the command line. You can also do most things through the Web Console.
Trials
When you create your first organization on Upsun, you are also activating your trial for that organization. Get more information on trials.
Initialize your Git repository
A Git repository is required for Upsun projects. If you haven’t already done so, initialize a Git repository for your codebase, and commit your files:
git init
git add .
git commit -m "Initial commit."This guide assumes that your repository’s default branch is main.
Your Git configuration may result in different default branches (like master), so please run git branch -M main before proceeding.
Don’t commit dependencies
Whether you’re migrating your own project, or testing Upsun with a starter project, never commit your app’s dependencies.
Make sure you ignore directories containing dependencies by updating your .gitignore file.
# JavaScript/Node.js
echo "node_modules" >> .gitignore
# PHP
echo "vendor" >> .gitignore
# Python
echo "env" >> .gitignore
git add .gitignore && git commit -m "Update .gitignore to ignore deps."