# Project

### Definition

{% hint style="info" %}
A **project** is a container of environments and architectures to which teams have access with specific permissions.
{% endhint %}

💡Think of a project as an upper level folder.

{% hint style="info" %}
 By default, members don't have direct permissions on projects unless the admin grants them access to.
{% endhint %}

***

### Create a new project

To create a new project:

1. Go to the [projects setting page](https://app.brainboard.co/settings/projects).
2. Click on the <mark style="color:$primary;">**`Create project`**</mark> button.&#x20;

<figure><img src="/files/K664uQVszfPBX1KSmJG0" alt=""><figcaption></figcaption></figure>

3. You will then go through a **project creation wizard** comprising of three steps: &#x20;

* **First step:** Here, you will set up the **name, description and environments** of the new project.&#x20;

{% hint style="info" %}
Brainboard creates 5 environments by default: **Production, Staging, Development, Test** and **QA.**&#x20;

You can also add any custom environment as well
{% endhint %}

{% hint style="warning" %}
The **project name** and at least one **environment** are required to create a new project.&#x20;
{% endhint %}

<figure><img src="/files/9IFsPbQ1qmGo8eQ6tXjA" alt=""><figcaption></figcaption></figure>

* **Second step:**  Here, you will need to assign **teams** to **roles**. You can do that by dragging and dropping each team into the corresponding role.&#x20;

{% hint style="warning" %}
You need to assign at least one team with the *admin* role.
{% endhint %}

<figure><img src="/files/34AzLH6bj3ctRGEi2v3o" alt=""><figcaption></figcaption></figure>

* **Third step:** Here, you can view the summary of the new project: *<mark style="color:$primary;">name, description, environment</mark>* and the *<mark style="color:$primary;">teams</mark>* assigned to this project with their *<mark style="color:$primary;">roles</mark>*.

4. Click the <mark style="color:$primary;">**`Create project`**</mark> button to save your project details. &#x20;

<figure><img src="/files/axTG9k3VrLPbjZFAQisW" alt=""><figcaption></figcaption></figure>

Upon clicking the <mark style="color:$primary;">**`Create project`**</mark> button, the new project's details will be saved, and you will be navigated to the[ project settings page](https://app.brainboard.co/settings/projects), where you can view the project details as well as edit it.&#x20;

### View the project's information

To view the information on a specific project:

1. Go to the [projects setting page](https://app.brainboard.co/settings/projects).
2. Click on the <mark style="color:$primary;">**`+`**</mark> icon next to the project name, and the project's details will be expanded, such as:&#x20;

* Name of the project.
* Teams that have access to this project with their respective roles.
* The environments of the project.&#x20;

<figure><img src="/files/Yn0SnpKx6WmlRq0sakeK" alt=""><figcaption></figcaption></figure>

Alternatively, you can click on the <mark style="color:$primary;">**`ellipsis icon`**</mark> next to the project name, and then select the <mark style="color:$primary;">**`View details`**</mark> option from the dropdown menu.&#x20;

<figure><img src="/files/dH9iIcxnrqjQZH7WI5j1" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Click the **cross&#x20;**<mark style="color:$primary;">**`x`**</mark> icon to collapse the project details view.&#x20;
{% endhint %}

### Edit project information

To edit the information on a project:

1. Go to the [projects setting page](https://app.brainboard.co/settings/projects).
2. Click on the <mark style="color:$primary;">**`ellipsis icon`**</mark> next to the project name, and then select the <mark style="color:$primary;">**`Edit project details`**</mark> option from the dropdown menu.&#x20;

<figure><img src="/files/437hLmnoUbBongzIirxO" alt=""><figcaption></figcaption></figure>

3. You can alter the project *<mark style="color:$primary;">name, description</mark>,* and *<mark style="color:$primary;">environments.</mark>*&#x20;
4. Click on the <mark style="color:$primary;">**`Save changes`**</mark> button in the top right corner of the <mark style="color:$primary;">**Edit project details**</mark> slide-out panel to save the new information.&#x20;

<figure><img src="/files/ljxRhN0O1dosRuefKn7p" alt=""><figcaption></figcaption></figure>

### Edit project roles

{% hint style="info" %}
By default, the following four types of roles are available for a <mark style="color:$primary;">**Brainboard**</mark> project:&#x20;

* Admin
* Designer
* Operator
* Guest
  {% endhint %}

To assign a role to a team: &#x20;

1. Go to the [projects setting page](https://app.brainboard.co/settings/projects).
2. Click on the <mark style="color:$primary;">**`ellipsis icon`**</mark> next to the project name, and then select the <mark style="color:$primary;">**`Assign teams`**</mark> option from the dropdown menu.&#x20;

<figure><img src="/files/ioXzJsIrJku5WqdzR373" alt=""><figcaption></figcaption></figure>

3. You can assign a role to a team as you did when you created a new project - simple **drag and drop a team** to the specific **role** that you want to assign to it.&#x20;
4. Click on the <mark style="color:$primary;">**`Update`**</mark> button to save the new information about the project.

{% hint style="warning" %}
Only the roles that are predefined for **Projects** on the [Roles page](https://app.brainboard.co/settings/roles) will be available for assignment.

For details, read the [Project Roles and Permissions](/data/data-structure/project-roles-and-permissions.md) article.&#x20;
{% endhint %}

### Delete project

To delete a project:

1. Go to the [projects setting page](https://app.brainboard.co/settings/projects).
2. Click on the <mark style="color:$primary;">**`ellipsis icon`**</mark> next to the project name, and then select the <mark style="color:$primary;">**`Delete project`**</mark> option from the dropdown menu.&#x20;
3. You'll be asked to confirm the deletion. To do so, type the word "<mark style="color:$primary;">**DELETE**</mark>" in the input field, and click the <mark style="color:$primary;">**`Yes, delete project button`**</mark>. &#x20;

{% hint style="warning" %}
Once you confirm the deletion action, the project will be permanently deleted.
{% endhint %}

{% hint style="info" %}
If there is only one project in your account, it cannot be deleted since your account needs at least one project.
{% endhint %}

<figure><img src="/files/Edy4P4znzdIYA1AZFXOY" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.brainboard.co/data/data-structure/projects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.