AI Wizard

AI Wizard is a rapid application assistant that helps developers quickly prototype and build applications.

Project Status

The project is currently in the early stages of development. The core functionality of collecting application requirements and generating corresponding code is implemented, but it is still missing many features and improvements.

A release candidate (RC) will be released when the project is considered production-ready.

Overview

The frontend application is a Single Page Application (SPA) that interacts with users to collect application specifications, refine requirements through iterative questioning, and ultimately generate the required code, tests, and documentation.

The backend application is a RESTful API that provides the core functionality of the application. It is responsible for storing the application requirements, generating the corresponding code, and providing the generated code to the frontend application.

The infrastructure is deployed using Terraform and AWS CloudFormation to AWS.

Prerequisites

Accounts

• AWS Account (AWS service deployment)
• GitHub Account (CI/CD pipeline)
• Google Firebase Account (Google OAuth provider)

Backend Tools

• AWS CLI (AWS service deployment)
• Python (v3.12 or later)
• Poetry (Python dependency management)
• Docker (optional, local container testing)

Frontend Tools

• Node.js (v14 or later)
• npm (Node Package Manager)

Setup

1. Clone the repository:

   git clone https://github.com/dom-ai/ai-wizard.git
   cd ai-wizard

2. Set up the backend AWS resources:

   • Navigate to the backend/aws-setup directory:

     cd backend/aws-setup

   • Run the setup script to create the necessary AWS CloudFormation stacks:

     ./setup.sh

3. Set up the frontend:

   cd frontend
   npm install

4. Set up the backend:

   cd ../backend
   poetry install

5. Set up environment variables:

   • Copy .env.example to .env in both the frontend and backend directories
   • Fill in the required values (see "External Services Setup" below)

6. Run database migrations:

   poetry run alembic upgrade head

Running the Application

1. Start the backend server:

   cd backend
   poetry run uvicorn app.main:app --reload

2. In a new terminal, start the frontend development server:

   cd frontend
   npm run dev

The application should now be running at http://localhost:8080 (frontend) and http://localhost:8000 (backend API).

External Services Setup

Google Firebase and OAuth

1. Create a new project in the Firebase Console.

2. Enable the Google sign-in method in the Authentication section.

3. Create a web app in your Firebase project to get the configuration details.

4. In the Google Cloud Console (linked from Firebase), create OAuth 2.0 Client IDs for your application.

5. Add the following to your frontend .env file:

   PUBLIC_FIREBASE_API_KEY=your_api_key
   PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
   PUBLIC_FIREBASE_PROJECT_ID=your_project_id
   PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
   PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
   PUBLIC_FIREBASE_APP_ID=your_app_id
   PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id
   PUBLIC_GOOGLE_CLIENT_ID=your_google_client_id

   Note: The PUBLIC_ prefix is used to make the variables available to the frontend (rsbuild framework).

6. Download the Firebase Admin SDK private key JSON file and save it as app/config/firebase-adminsdk.json in the backend directory.

OpenAI API

1. Sign up for an account at OpenAI.
2. Generate an API key in your account dashboard.
3. Add the following to your backend .env file:

   OPENAI_API_KEY=your_openai_api_key

Running Tests

Frontend Tests

npm test

Backend Tests

poetry run pytest

Deployment

For deployment, consider using Docker. A Dockerfile is provided for the backend. To build and run the Docker container locally (if not using the CI/CD pipeline):

1. Build the Docker image:

   docker build -t ai-wizard-backend .

2. Run the Docker container:

   docker run -d -p 8000:8000 ai-wizard-backend

License

MIT License

Copyright (c) 2024 Dominikus Nold

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.