Upsun User Documentation

Set up your app and repository

Upsun Beta access

Test and provide feedback for our newest offering - Upsun!

You can register for the Beta by clicking here and completing the form.

Sign up for Beta access

You can start with an existing Flask app, or generate a new app using Cookiecutter.

Optional: Generate a Flask project with Cookiecutter Anchor to this heading

  1. To generate a Flask project with Cookiecutter, run the following command:

    Terminal
    cookiecutter https://github.com/cookiecutter-flask/cookiecutter-flask.git

    Alternatively, if you’ve already generated a Flask project with Cookiecutter before, indicate the specific template you want to use:

    Terminal
    cookiecutter cookiecutter-flask
  2. To configure your Flask project, follow the prompts and enter responses similar to the following:

    [1/10] full_name (): John Doe
    [2/10] email (): john.doe@upsun.com
    [3/10] github_username (): jdoe
    [4/10] project_name (): my_flask_project
    [5/10] app_name (): my_flask_app
    [6/10] project_short_description (): A demonstration project
    [7/10] use_pipenv (): n
    [8/10] python_version (): 3.11
    [9/10] node_version (): 18
    [10/10] use_heroku (): N

    Keep note of your app_name for later use.
    After you’ve gone through all the prompts, your Flask project is generated.

Initialize your Git repository Anchor to this heading

  1. Navigate to your Flask project directory.
    If youโ€™ve generated your Flask project with Cookiecutter, run the following command, using the app_name defined previously:

    Terminal
    cd app_name
  2. To initialize the contents of the directory as a Git repository, run the following command:

    Terminal
    git init

    By default, Git uses master as the name for the initial branch.
    To change the default branch name, run git branch -m NEW_BRANCH_NAME.

Is this page helpful?