Project Documentation

Overview

This project is a web application built with Next.js, designed to help users find their dream high schools based on their preferences. It leverages AI embeddings to recommend schools that best match the user's description.

Features

• School Recommendations: Users can describe their ideal high school, and the application will suggest the top three matches.
• Real-time Form Submission: The form supports real-time submission with a custom submit button that indicates loading status.

Prerequisites

Ensure you have the following installed:

• Node.js
• npm, yarn, pnpm, or bun (for package management)

Installation

1. Clone the repository:

   git clone <repository-url>

2. Install dependencies:

   npm install

Running the Development Server

To start the development server, run:

npm run dev

Building for Production

To build the application for production, run:

npm run build

Starting the Production Server

To start the production server, run:

npm start

Linting

To lint the codebase, run:

npm run lint

Database Management

Ensure your database is set up and configured correctly. Refer to the database schema and connection settings in the src/lib/db/schema file.

Environment Variables

Make sure to set up the necessary environment variables as specified in the .env file. These include the OPENAI_API_KEY for accessing OpenAI services, LIBSQL_URL for the database connection, and TURSO_AUTH_TOKEN for authentication. Ensure these variables are correctly set to enable the application to function properly.