unisono/README.md

Unisono Project

This project implements a collaborative idea generation and harmonization tool.

Simple HTTP Auth Feature

This feature provides a basic HTTP authentication mechanism for the Single Page Application (SPA).

Setup

1. Create a .env file in the backend/ directory:

   cd backend
   touch .env
   

   Add the following line to backend/.env, replacing YOUR_PASSPHRASE_HERE with your desired secret passphrase:

   AUTH_PASSPHRASE=YOUR_PASSPHRASE_HERE
   

   Note: If AUTH_PASSPHRASE is missing or empty, the application will start without authentication.

2. Build and run the application using Docker Compose:

   docker-compose up --build
   

   This will build the frontend and backend services and start them.

Usage

1. Access the application: Open your web browser and navigate to http://localhost:3000.

2. Enter the passphrase: You will be presented with a screen prompting you to enter the passphrase. Enter the passphrase you configured in backend/.env.

3. Access the SPA: Upon successful authentication, you will gain access to the Single Page Application. Your access will be preserved for the duration of your browser session.

Deployment

The application is designed to be deployed to a custom host. This requires configuring environment variables for the frontend and backend to ensure they can communicate correctly without CORS errors.

For detailed instructions on how to configure the application for a custom domain, please see the Deployment Quickstart Guide.