# Projects {#projects}



## Page Overview {#page-overview}



### What the page is for {#what-the-page-is-for}
The Projects page allows you to manage projects within a workspace. Projects organize your surveys into logical groups and help you track their progress through different statuses (Draft, Active, Completed, Archived).


### When a user would use it {#when-a-user-would-use-it}
- When you want to create new projects to organize surveys
- When you need to view all projects in a workspace
- When you want to edit project details or change project status
- When you want to view surveys or analytics for a project
- When you need to delete an unused project


## How to Access This Page {#how-to-access-this-page}



### Navigation path from the main app {#navigation-path-from-the-main-app}
1. Log in to the application
2. Go to the Workspaces page
3. Click "View Projects" on the workspace you want to explore
4. Or, directly navigate to `/workspaces/{workspaceId}/projects` in your browser


### Permissions or prerequisites {#permissions-or-prerequisites}
- You must be logged in to access this page
- Only administrators can create projects
- The "Create Project" button will be disabled for non-admin users


## Page Layout {#page-layout}



### Back button {#back-button}
- **Button**: "Back to Workspaces" (with left arrow icon)
- Takes you back to the Workspaces page


### Header / title {#header--title}
- **Title**: "Projects"
- **Subtitle**: "Manage projects within this workspace"
- **Primary button**: "Create Project" (available only to admins)


### Search {#search}
- A search bar with placeholder text: "Search projects by name or description..."
- Located above the project table
- Allows you to filter projects by typing keywords in the name or description


### Table {#table}
The table shows a list of projects with these columns (left to right):
1. **Name**: The project name
2. **Description**: A short description of the project (shows "-" if empty)
3. **Status**: A colored badge showing the project status:
   - Draft (yellow)
   - Active (green)
   - Archived (gray)
   - Deleted (red)
4. **Created**: The date the project was created
5. **Actions**: A menu with available actions for the project


### Action menu (per project) {#action-menu-per-project}
Clicking on the three-dot icon (⋮) next to a project opens a dropdown menu with these options:
- **View Surveys**: Takes you to the surveys page filtered by this project
- **Analytics**: Takes you to the analytics page for this project
- **Edit Details**: Opens the edit dialog for the project
- **Set Active**: Changes status to Active (disabled if already active)
- **Archive**: Changes status to Archived (disabled if already archived)
- **Set to Draft**: Changes status to Draft (disabled if already draft)
- **Delete**: Opens the delete confirmation dialog (text is red, separated by a line from other options)


## Step-by-Step Tasks {#step-by-step-tasks}



### Creating a Project {#creating-a-project}
1. Click the "Create Project" button at the top of the page
2. In the "Create Project" dialog:
   a. Enter a name in the "Project Name" field (required)
   b. (Optional) Enter a description in the "Description" field
3. Click the "Create Project" button
4. The dialog will close, and the new project will appear in the table


### Editing a Project {#editing-a-project}
1. Find the project you want to edit in the table
2. Click the three-dot menu icon (⋮)
3. Select "Edit Details"
4. In the "Edit Project" dialog:
   a. Update the project name (required)
   b. (Optional) Update the description
   c. (Optional) Change the status from the dropdown menu
5. Click "Save Changes"
6. The dialog will close, and your changes will be saved


### Changing Project Status {#changing-project-status}
There are two ways to change project status:

**Option 1: Quick change from menu**
1. Find the project in the table
2. Click the three-dot menu icon (⋮)
3. Select "Set Active", "Archive", or "Set to Draft" (depending on the current status)
4. The status will update immediately

**Option 2: Via edit dialog**
1. Find the project and select "Edit Details"
2. In the "Status" dropdown, choose a new status:
   - Draft: Project is being prepared
   - Active: Project is active and accepting surveys
   - Completed: Project is completed
   - Archived: Project is archived (read-only)
3. Click "Save Changes"


### Deleting a Project {#deleting-a-project}
1. Find the project you want to delete in the table
2. Click the three-dot menu icon (⋮)
3. Select "Delete"
4. Read the confirmation message carefully (it says this action cannot be undone and will delete all surveys and data)
5. If you're sure, click "Delete Project"
6. The dialog will close, and the project will be removed from the table


### Searching for a Project {#searching-for-a-project}
1. Click in the search bar above the table
2. Type a keyword from the project name or description
3. The table will automatically filter to show only matching projects


### Viewing Surveys in a Project {#viewing-surveys-in-a-project}
1. Find the project you want to explore
2. Click the three-dot menu icon (⋮)
3. Select "View Surveys"
4. You'll be taken to the surveys page filtered to show only surveys in this project


### Viewing Analytics for a Project {#viewing-analytics-for-a-project}
1. Find the project you want to analyze
2. Click the three-dot menu icon (⋮)
3. Select "Analytics"
4. You'll be taken to the analytics page for this project


## Field & Button Reference {#field--button-reference}


| Field/Button | What it does | When to use it |
|--------------|--------------|----------------|
| Back to Workspaces | Navigates back to the Workspaces page | When you want to return to the workspaces list |
| Create Project | Opens the dialog to create a new project | When you need to organize a new set of surveys |
| Search bar | Filters projects by name or description | When you have many projects and need to find a specific one |
| Name column | Shows the project name | To identify projects at a glance |
| Description column | Shows the project description (or "-" if empty) | To understand the purpose of a project |
| Status column | Shows project status as a colored badge | To quickly see if a project is draft, active, completed, or archived |
| Created column | Shows when the project was created | To see how old a project is |
| Actions menu (⋮) | Opens the menu of available actions | When you want to manage a project |
| View Surveys | Navigates to surveys in this project | When you want to see or manage surveys for a project |
| Analytics | Navigates to analytics for this project | When you want to view data and insights for a project |
| Edit Details | Opens the project edit dialog | When you need to update the name, description, or status |
| Set Active | Changes status to Active | When you're ready to start working on a project |
| Archive | Changes status to Archived | When you want to keep a project but no longer need to modify it |
| Set to Draft | Changes status to Draft | When you want to move a project back to preparation phase |
| Delete | Opens the delete confirmation dialog | When you no longer need a project and want to remove it |


## Tips & Notes {#tips--notes}


- **Be careful when deleting**: Deleting a project will delete all surveys and associated data, and this cannot be undone
- **Use descriptive names**: Give projects clear names that reflect their purpose (e.g., "2025 Health Survey" instead of just "Project 1")
- **Add descriptions**: Descriptions help other team members understand what each project is for
- **Use statuses wisely**:
  - Use "Draft" when planning a project
  - Use "Active" when the project is ready for surveys
  - Use "Completed" when the project is finished
  - Use "Archived" for old projects you don't want to modify but want to keep
- **You can't create projects if you're not an admin**: The "Create Project" button will be grayed out if you don't have admin permissions
- **Search works for both name and description**: You can search using any keyword that appears in either the name or description field