Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update-readme-and-supabase-migration #37

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update-readme-and-supabase-migration #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 43 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Welcome to the **devcontainer-generator** project! This tool helps you automatic

1. [Project Structure](#project-structure)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Configuration](#configuration)
3. [Configuration](#configuration)
4. [Usage](#usage)
5. [Setting Up Daytona Workspace](#setting-up-daytona-workspace)
6. [Contributing](#contributing)
7. [License](#license)
Expand Down Expand Up @@ -55,23 +55,10 @@ To run this project in Daytona, you'll need to have Daytona installed. Follow th
AZURE_OPENAI_API_VERSION=your_azure_openai_api_version
MODEL=your_model_name
GITHUB_TOKEN=your_github_token
SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_api_key
```

## Usage

Run the `main.py` script to start the FastHTML app and generate `devcontainer.json` files. Here's how you can do it:

```bash
python main.py
```

**Instructions:**

1. After starting the app, open your web browser and go to `http://localhost:8000`.
2. Enter the URL of the GitHub repository for which you want to generate a `devcontainer.json` file.
3. Click the "Generate devcontainer.json" button.
4. The generated `devcontainer.json` will be displayed and can be copied to your clipboard.

## Configuration

### Azure OpenAI and Instructor Clients
Expand All @@ -86,14 +73,50 @@ MODEL=your_model_name
GITHUB_TOKEN=your_github_token
```

### SQLite Database
### Supabase Database Setup
The project uses a Supabase database to store the generated devcontainer.json files and their embeddings. Ensure you have set up a Supabase project and added the following environment variables to your .env file.

To set up the Supabase database and create the necessary tables, follow these steps:

1. Log in to your Supabase project dashboard.
2. Navigate to the SQL Editor.
3. Run the following SQL command to create the `devcontainers` table:

The project uses an SQLite database to store the generated `devcontainer.json` files and their embeddings. The database is located in the `data` directory.
```
CREATE TABLE public.devcontainers (
id SERIAL PRIMARY KEY,
url TEXT NOT NULL,
devcontainer_json TEXT NOT NULL,
devcontainer_url TEXT,
repo_context TEXT NOT NULL,
tokens INT NOT NULL,
model TEXT NOT NULL,
embedding TEXT,
generated BOOLEAN NOT NULL,
created_at TIMESTAMP DEFAULT NOW()
);

```
After creating the table, you can use the Supabase client in your Python code to interact with the database.

### JSON Schema

The JSON schema for the `devcontainer.json` file is located in `schemas/devContainer.base.schema.json`.

## Usage

Run the `main.py` script to start the FastHTML app and generate `devcontainer.json` files. Here's how you can do it:

```bash
python main.py
```

**Instructions:**

1. After starting the app, open your web browser and go to `http://localhost:8000`.
2. Enter the URL of the GitHub repository for which you want to generate a `devcontainer.json` file.
3. Click the "Generate devcontainer.json" button.
4. The generated `devcontainer.json` will be displayed and can be copied to your clipboard.
## Setting Up Daytona Workspace

**Steps to Set Up Daytona Workspace**
Expand Down Expand Up @@ -126,4 +149,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file

---

Thank you for using **devcontainer-generator**! If you have any questions or issues, feel free to open an issue on GitHub.
Thank you for using **devcontainer-generator**! If you have any questions or issues, feel free to open an issue on GitHub.