> For the complete documentation index, see [llms.txt](https://docs.brainboard.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brainboard.co/data/data-structure/projects.md).

# 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.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FeKxhiuoQXxycCLd1eSOO%2Fimage.png?alt=media&amp;token=10981b13-8d20-4a49-b423-63b8ffacabfd" alt=""><figcaption></figcaption></figure>

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

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

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

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.
{% endhint %}

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F71z2FF8Bq1RKmka21aoO%2Fimage.png?alt=media&amp;token=b2e7bcaf-cd3b-4cef-924f-6ff4a3ac151a" 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.

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

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F3fZxBtWQpFSMV1fraXpg%2Fimage.png?alt=media&amp;token=1b6cbe95-2c5b-474a-abfa-008f60e73d54" 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.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FEwSLGFbbUewXkNRxXpE1%2Fimage.png?alt=media&amp;token=8e1ab478-0120-4df2-8549-d69b854508e7" 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.

### 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:

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

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FVq26Jfk7BVFJTaOjqGtT%2FView-Project.png?alt=media&amp;token=d68b5858-ce3d-4f9f-8255-30a897fa3df8" 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.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FSIGkndHNdbjQn0rwTYZ3%2Fimage.png?alt=media&amp;token=8d2bc7bc-25e3-449d-9b33-1e4de5dc16fc" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FEWcbG6kaM45WUBmzqG2M%2Fimage.png?alt=media&amp;token=6c4d21aa-84ae-4371-8756-9a0b53272fa0" alt=""><figcaption></figcaption></figure>

3. You can alter the project *<mark style="color:$primary;">name, description</mark>,* and *<mark style="color:$primary;">environments.</mark>*
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.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F6CurigGWpEwNJB761oPO%2Fedit-project.png?alt=media&amp;token=871d60c8-1b0f-4d3b-90c2-e67794758f72" 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:

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

To assign a role to a team:

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.

<figure><img src="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2FEm4T8KRbVDSPf8Vicu02%2Fassign-teams.png?alt=media&amp;token=58d3fc3a-0330-4f41-a191-deb4da3aee80" 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.
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.
{% 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.
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>.

{% 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="https://2733077811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7YhVIZuz5Brv8kisTlFL%2Fuploads%2F9wcTZW8ELDL3DFlK6Qu7%2Fdelete-project.png?alt=media&amp;token=ef65cbbb-ccb8-41ec-a01a-c8947d2d9c76" alt=""><figcaption></figcaption></figure>
