@devries-cameron20 / OCIU-npo Mirror · read-only
Fork 0

Mirrored from https://github.com/Camo67/OCIU-npo.git

Synced Nov 21, 07:15 UTC

1 # Welcome to your Lovable project
2
3 ## Project info
4
5 **URL**: https://lovable.dev/projects/2f8afc79-59cb-4ed5-a0fb-eb3af1338420
6
7 ## How can I edit this code?
8
9 There are several ways of editing your application.
10
11 **Use Lovable**
12
13 Simply visit the [Lovable Project](https://lovable.dev/projects/2f8afc79-59cb-4ed5-a0fb-eb3af1338420) and start prompting.
14
15 Changes made via Lovable will be committed automatically to this repo.
16
17 **Use your preferred IDE**
18
19 If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
20
21 The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
22
23 Follow these steps:
24
25 ```sh
26 # Step 1: Clone the repository using the project's Git URL.
27 git clone <YOUR_GIT_URL>
28
29 # Step 2: Navigate to the project directory.
30 cd <YOUR_PROJECT_NAME>
31
32 # Step 3: Install the necessary dependencies.
33 npm i
34
35 # Step 4: Start the development server with auto-reloading and an instant preview.
36 npm run dev
37 ```
38
39 **Edit a file directly in GitHub**
40
41 - Navigate to the desired file(s).
42 - Click the "Edit" button (pencil icon) at the top right of the file view.
43 - Make your changes and commit the changes.
44
45 **Use GitHub Codespaces**
46
47 - Navigate to the main page of your repository.
48 - Click on the "Code" button (green button) near the top right.
49 - Select the "Codespaces" tab.
50 - Click on "New codespace" to launch a new Codespace environment.
51 - Edit files directly within the Codespace and commit and push your changes once you're done.
52
53 ## CamoFlow OS
54
55 CamoFlow OS is a local-first AI operating system with Obsidian as the central brain.
56
57 ### Features
58 - **Local-first**: Runs on CPU via Ollama (Qwen3 models).
59 - **Model Routing**: Auto-selects model size based on task complexity and RAM pressure.
60 - **Obsidian Brain**: Uses an Obsidian vault for memory, logs, and context.
61 - **Agentic Workflows**: Includes specialized agents for Code, Content, Voice, and Web Design.
62
63 ### Stack
64 - **Backend**: FastAPI orchestration layer.
65 - **Frontend**: React + Tailwind + Shadcn UI.
66 - **Models**: Ollama (Qwen3-0.5B, 4B, 8B).
67 - **Deployment**: Docker Compose.
68
69 ### Setup
70 1. Copy `.env.example` to `.env` and fill in API keys if needed (for fallback).
71 2. Install Ollama and pull required models:
72 ```bash
73 ollama pull qwen3:0.5b
74 ollama pull qwen3:4b
75 ollama pull qwen3:8b
76 ```
77 3. Run with Docker Compose:
78 ```bash
79 docker-compose up --build
80 ```
81
82 ### Asset Configuration
83 For optimal performance of specialized agents:
84 - **Voice Studio**: Place 10–15 minutes of clean voice samples (.wav or .mp3) in `backend/assets/voice_samples/` for high-quality Coqui voice cloning.
85 - **3D Avatar**: Drop a clean front-facing photo in `backend/assets/avatar_faces/` (default: `user_face.jpg`).
86
87 ### Business Suite Integration
88 The CamoFlow Business Suite is pre-configured to route through this OS. You can test the bridge using:
89 `POST /business-suite/content-studio` or `POST /business-suite/prospect-engine`.
90
91 ## What technologies are used for this project?
92
93 This project is built with:
94
95 - Vite
96 - TypeScript
97 - React
98 - shadcn-ui
99 - Tailwind CSS
100 - FastAPI
101 - Ollama
102
103 ## How can I deploy this project?
104
105 Simply open [Lovable](https://lovable.dev/projects/2f8afc79-59cb-4ed5-a0fb-eb3af1338420) and click on Share -> Publish.
106
107 ## Can I connect a custom domain to my Lovable project?
108
109 Yes, you can!
110
111 To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
112
113 Read more here: [Setting up a custom domain](https://docs.lovable.dev/features/custom-domain#custom-domain)