Projects and services
Projects
Create, find, rename and delete projects, and what a project holds and does not hold.
Updated
A project holds the applications, databases and compose stacks that make up one product. It has a name, an address in the console, and the services inside it; it has no settings of its own beyond that. Every project belongs to one organization, the one the console was in when it was created, and its services run and are billed there (Organizations).
Create a project
On Projects, press New project. The dialog asks for one field:
Name: 1 to 60 characters. The line under it counts them and says "Its address is derived from it."
Press Create project. The dialog closes, a message says the project was created, and it appears in the list.
The address is made from the name once, when the project is created: letters lose their accents, everything is lowercased, and each run of other characters becomes one hyphen. Docs demo becomes /projects/docs-demo. A name with no letters or digits at all gets an address of project- followed by six random characters.
A project is refused when:
| Sentence | Why |
|---|---|
| "Give the project a name." | The name is empty. |
| "A project name is at most 60 characters." | The name is longer. |
| "You already have a project with that name." | Its address matches another project in the organization, such as Shop! while Shop exists. Another of your organizations may have a project at the same address. |
New project is not shown until the organization's workspace is ready. While it is being prepared, the page says "Your workspace is still being prepared." and checks again every few seconds.
Find a project
Projects lists every project in the organization the console is in, twelve to a page by default. To see another organization's, switch to it at the top of the sidebar.
Search projects matches each project's name and address. With no match, the page says so and offers Clear the search.
Sort orders the list by Recently updated (the default), Least recently updated, Name, A to Z, Name, Z to A, Most services or Fewest services.
The two buttons beside Sort switch between a list and cards. The list shows each project's name, address, service count and last update, and can be sorted by pressing a column's name.
Under the list, choose 12, 24 or 48 projects a page, and move with Prev and Next.
The search, the order, the layout and the page are kept in the page's address, so a reload or a shared link shows the same list.
The Dashboard also shows the organization's eight most recently updated projects, with View all to open this page. The search in the top bar (Cmd K or Ctrl K) finds one of its projects by name or address from any screen.
Open a project
Select a project's card or row to open it. The project's page lists its services with their kind, source, state and last deploy, and each row has its own Visit, Deploy and delete controls. Its header has Settings and Add a service. A project card offers the same two as icons: the plus adds a service and the gear opens the project's settings.
An empty project says "No services yet". Service lifecycle covers what happens to a service after you add it.
Rename a project
Open the project's Settings. The Name card holds Project name; type the new name and press Save name.
The address never changes: the line under the field says "Its address stays" followed by the current address, so every link to the project keeps working.
The new name can be up to 60 characters, and cannot be the name of another project in the organization, whatever its capitals.
The Details card on the same page shows the project's Address, how many Services it holds, and when it was Created and last Updated.
Delete a project
A project is deleted only once it holds no services. Delete each service first, as Service lifecycle describes, then either:
on the project's Settings, press Delete project on the Delete project card, type the project's name under Project name, and confirm; or
on Projects in list layout, press the delete button on the project's row and confirm.
While the project holds services, both buttons are greyed out, and the card says how many services it still holds. Deleting a project cannot be undone.
What a project does not have
Environments. A project has no staging or preview environment of its own. To run a second copy of a product, create a second project.
Shared settings. Environment variables, domains and volumes belong to each service, not to the project.
Moving services. A service stays in the project it was created in.
Moving to another organization. A project stays in the organization it was created in, with everything in it.