Create a new project

Project names

An Akka Serverless project must have a name and can have a description. It is good practice to name and describe the project so that you and other project members can identify it and its purpose.

Project names must conform to the following:

  • Up to 63 characters

  • Can include:

    • lowercase letters

    • numbers

    • hyphens (-)

  • Must not:

    • start or end with hyphens (-)

  • Cannot include:

    • underscores (_)

    • spaces

    • non-alphanumeric characters

Create a new project

To create a new project, follow the steps below:

Console
  1. Sign into your Akka Serverless account at: https://console.akkaserverless.com/

    The Projects page opens.

  2. Click the Add New Project button.

  3. Enter a Project name.

  4. Enter a description in the Description field.

  5. Select the region for the project using the Region drop-down. Currently, all new projects will be created in the US region us-east1.

  6. Click submit.

    Your project should appear in the Projects list.

CLI
  1. If you haven’t done so yet, log into your account:

    akkasls auth login
  2. Create a project by substituting your project name and placing a short project description name in quotes, followed by the region flag. Note that currently, you need to use the only available region, us-east1.:

    akkasls projects new <projectname> "project description" --region=<region>

    For example:

    akkasls projects new my-akka-proj "My Akka Serverless Project" --region=us-east1

    When the command is successfully completed a response is returned similar to the following:

    NAME           DESCRIPTION   ID                                     OWNER
    my-akka-proj   "My ..        xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   id:"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    
    'my-akka-proj' is now the currently active project.