61 lines
2.2 KiB
Markdown
61 lines
2.2 KiB
Markdown
# Quickstart Guide: Afraid to Ask Feature
|
|
|
|
**Feature Branch**: `004-afraid-to-ask`
|
|
**Date**: October 13, 2025
|
|
**Spec**: ../../specs/004-afraid-to-ask/spec.md
|
|
|
|
## Overview
|
|
|
|
This guide provides a quick overview of how to set up and interact with the "Afraid to Ask" feature. This feature allows users to submit sensitive ideas privately, which are then semantically matched against other participants' desires.
|
|
|
|
## Setup
|
|
|
|
1. **Clone the repository**:
|
|
```bash
|
|
git clone [repository_url]
|
|
cd unisono
|
|
git checkout 004-afraid-to-ask
|
|
```
|
|
2. **Install dependencies**:
|
|
* **Backend**:
|
|
```bash
|
|
cd backend
|
|
npm install
|
|
```
|
|
* **Frontend**:
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
```
|
|
3. **Environment Variables**: Ensure the necessary environment variables are set for the Google Cloud Natural Language API in the backend. Refer to the `.env.example` file in the `backend` directory.
|
|
|
|
## Running the Application
|
|
|
|
1. **Start the Backend**:
|
|
```bash
|
|
cd backend
|
|
npm start
|
|
```
|
|
2. **Start the Frontend**:
|
|
```bash
|
|
cd frontend
|
|
npm start
|
|
```
|
|
3. Access the application in your browser, typically at `http://localhost:3000`.
|
|
|
|
## Interacting with the Feature
|
|
|
|
1. **Create a Session**: Navigate to the session creation page and create a new session.
|
|
2. **Submit "Afraid to Ask" Ideas**:
|
|
* Join the session as a participant.
|
|
* Locate the new "Afraid to Ask" input field on the response form (under "What you want").
|
|
* Enter your sensitive ideas into this field and submit your response.
|
|
3. **Observe Matching**:
|
|
* Have other participants submit their "Want" or "Accept" ideas.
|
|
* Observe the session results. If your "Afraid to Ask" idea semantically matches another participant's "Want" or "Accept", it will appear as a "Want" for you in the results. Otherwise, it will remain private.
|
|
4. **Terminate Session**: Terminate the session to ensure all "Afraid to Ask" data is purged from the server.
|
|
|
|
## API Endpoints
|
|
|
|
Refer to `specs/004-afraid-to-ask/contracts/openapi.yaml` for detailed API documentation, including endpoints for submitting responses, retrieving results, and terminating sessions.
|