A project is a logical structure that groups deployments and aliases inside of an account or team, based on the name of the project. This structure allows easier tracking and managing of deployments.
The projects structure enables faster locating of deployments logs, source, and aliases.
The Projects dashboard.
Creating a Project
A project can be created either from the ZEIT account or team dashboard, by using Now CLI, or automatically when deploying.
1. From the Dashboard
Simply visit the ZEIT dashboard(optionally selecting a team from the team picker), then click on the "Projects" link in the dashboard navigation.
Then you can create a project by just giving a name.
Creating a Project from the dashboard.
2. With Now CLI
You can create project by just typing the following command:
Creating a project with Now CLI.
Creating a Project from Now CLI.
3. Automatic Project Creation
This is simplest way to create a project as it does not require any action from the user. A project will automatically be created when making a deployment using the defined name.
(To select a project for a deployment, check the following section)
Selecting an Existing Project for a Deployment
When deploying an app, you can select an existing project for it. To do this, either:
1. Select the Project from Now CLI
Use the --name
option to mention the project name as follows:
Deploying the current directory with Now CLI and --name
option.
2. Select the Project via now.json
You can specify the project for your deployment by using the name
property of the now.json
{ "name": "<your-project-name>", "version": 2 }
An example now.json
file defining a name of a project and the platform version.
3. Automatic Project Selection
If you didn't specify a project name explicitly via one of the above methods, we try to select a project automatically based on following rules:
- If this is GitHub deployment, we use the GitHub repo name as the project
- If this is a Now CLI based deployment, we use the directory name of your app as the project
- If this is a file or a set of files, we use the
files
project
Deleting a Project
You can remove a project and all of the deployments contained within it with the following Now CLI command:
Read Next
With a project set up, you can now go on to learn about what to do when deploying and what to do with those deployments: