Intellara-AI

An advanced AI-powered application with a full-stack architecture featuring both client and server components.

Table of Contents

• Overview
• Features
• Prerequisites
• Installation
• Usage
• Project Structure
• Scripts
• Environment Variables
• Contributing
• License

Overview

Intellara-AI is a sophisticated AI application that combines modern web technologies with artificial intelligence capabilities. The application features a client-side interface and a server-side API, designed to provide intelligent solutions and services.

Features

• Modern web interface with responsive design
• AI-powered functionality
• RESTful API architecture
• Real-time communication capabilities
• Secure authentication and authorization
• Scalable backend architecture

Prerequisites

• Node.js (v16 or higher)
• npm (v8 or higher)
• Git
• PowerShell (for Windows users) or bash (for macOS/Linux users)

Installation

Quick Setup (Windows - PowerShell)

1. Clone the repository:

   git clone https://github.com/Intellara/Intellara-AI.git
   cd Intellara-AI

2. Run the setup script:

   .\Setup-Project.ps1

Manual Setup

1. Clone the repository:

   git clone https://github.com/Intellara/Intellara-AI.git
   cd Intellara-AI

2. Install server dependencies:

   cd server
   npm install
   cd ..

3. Install client dependencies:

   cd client
   npm install
   cd ..

4. Create environment files (see Environment Variables section)

Usage

Development

To run both client and server in development mode:

.\Start-Development.ps1

This will start both the client and server with hot reloading enabled.

Building

To build the project for production:

.\Build-Project.ps1

Testing

To run tests:

.\Test-Project.ps1

For server-only tests:

.\Test-Project.ps1 -Target "server"

For client-only tests:

.\Test-Project.ps1 -Target "client"

Project Structure

Intellara-AI/
├── .gitignore          # Git ignore file
├── LICENSE             # License information
├── README.md           # This file
├── Setup-Project.ps1   # Setup script
├── Start-Development.ps1 # Development start script
├── Build-Project.ps1   # Build script
├── Test-Project.ps1    # Test script
├── .env               # Environment variables (not committed)
├── client/            # Client-side code
│   ├── public/
│   ├── src/
│   ├── package.json
│   └── ...
└── server/            # Server-side code
    ├── src/
    ├── routes/
    ├── package.json
    └── ...

Scripts

This project includes several PowerShell scripts to simplify common tasks:

• Setup-Project.ps1: Sets up the project by installing dependencies for both client and server
• Start-Development.ps1: Starts both client and server in development mode
• Build-Project.ps1: Builds the project for production
• Test-Project.ps1: Runs tests for the project

Environment Variables

Create a .env file in the root directory with the following variables:

# Server Configuration
PORT=3000
NODE_ENV=development
DB_HOST=localhost
DB_PORT=5432
DB_NAME=intellara_ai
DB_USER=postgres
DB_PASSWORD=postgres

# Client Configuration
REACT_APP_API_URL=http://localhost:3000

# Additional API Keys (if needed)
OPENAI_API_KEY=

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.