SQUAADS-AI-WIZARD is an AI-powered tool designed to enhance software development workflows by providing intelligent insights and documentation for your projects.
- Repository Analysis: Connect your repositories to generate a comprehensive context of your code structure and relationships.
- High-Level Documentation: Automatically create technical documentation describing your project's infrastructure and connections.
- Mermaid Diagram Generation: Visualize your project's architecture with automatically generated Mermaid diagrams.
- AI-Optimized Prompt Generation: Create optimized prompts for AI assistance in future development tasks.
- Node.js (version 16.13 or higher)
- npm or yarn
- Docker
-
Clone the repository:
git clone https://github.com/your-username/squaads-ai-wizard.git cd squaads-ai-wizard -
Install dependencies:
npm install -
Start the PostgreSQL database using Docker:
docker-compose up -d -
Set up the environment variables:
cp .env.example .envThen, edit the
.envfile and set theDATABASE_URLto:DATABASE_URL="postgresql://admin:password@localhost:5432/squaads_ai_wizard?schema=public" -
Run Prisma migrations:
npx prisma migrate dev -
Generate Prisma client:
npx prisma generate -
Run prisma seed
npx prisma db seed -
Start the development server:
npm run dev -
Open http://localhost:3000 with your browser to see the result.
The application uses a simple username and password authentication system. To log in, use the following credentials:
- Username: admin
- Password: password (replace with the actual password you set in the seed script)
Note: For production use, it's recommended to implement a more robust authentication system.
This project uses shadcn/ui components. To add new components, use the following command:
npx shadcn-ui@latest add [component-name]
To learn more about the technologies used in this project, check out the following resources:
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License.