Skip to content

Commit a91ec97

Browse files
Gerome-ElassaadGerome-Elassaad
committed
readme_assets fixed
1 parent 2751a77 commit a91ec97

File tree

1 file changed

+43
-58
lines changed

1 file changed

+43
-58
lines changed

‎README.md‎

Lines changed: 43 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,20 @@
11
<p align="center">
2-
<div style="position: relative; width: 100%; height: 0; padding-bottom: 56.25%;">
3-
4-
<video autoplay muted loop playsinline class="w-full aspect-video rounded-lg mb-6" src="/readme_assets/walkthrough.mp4"></video>
5-
6-
</div>
7-
8-
<div>
9-
<a href="https://sourceforge.net/projects/codinit-dev/files/latest/download"><img alt="Download CodinIT.dev" src="https://img.shields.io/sourceforge/dm/codinit-dev.svg" ></a>
10-
</div>
11-
2+
<a href="/readme_assets/walkthrough.mp4">
3+
▶️ Watch Full Demo Video
4+
</a>
125
</p>
136

147
<p align="center">
15-
<!-- HuntScreens Feature Badge -->
16-
<a href="https://huntscreens.com/en/products/codinit"
17-
target="_blank"
18-
title="Featured on HuntScreens"
19-
aria-label="Featured on HuntScreens">
20-
<img src="https://shot.huntscreens.com/badge.svg"
21-
alt="Featured on HuntScreens"
22-
width="240"
23-
height="60"
24-
loading="lazy" />
8+
<a href="https://sourceforge.net/projects/codinit-dev/files/latest/download">
9+
<img alt="Download CodinIT.dev" src="https://img.shields.io/sourceforge/dm/codinit-dev.svg">
2510
</a>
11+
</p>
2612

27-
<br/>
28-
29-
<!-- SourceForge Download Button (moved under HuntScreens badge) -->
13+
<p align="center">
14+
<a href="https://huntscreens.com/en/products/codinit" target="_blank" title="Featured on HuntScreens">
15+
<img src="https://shot.huntscreens.com/badge.svg" alt="Featured on HuntScreens" width="240" height="60"/>
16+
</a>
17+
<br/><br/>
3018
<a href="https://sourceforge.net/projects/codinit-dev/files/latest/download">
3119
<img alt="Download CodinIT.dev"
3220
src="https://a.fsdn.com/con/app/sf-download-button"
@@ -36,7 +24,6 @@
3624
</a>
3725
</p>
3826

39-
4027
<p align="center">
4128
<strong>⚡ CodinIT.dev — OpenSource AI App Builder ⚡</strong><br/>
4229
Build, manage, and deploy intelligent applications directly from your browser or desktop.
@@ -53,9 +40,9 @@ Get up and running with **CodinIT.dev** in just a few steps.
5340
```bash
5441
git clone https://github.com/Gerome-Elassaad/codinit-app.git
5542
cd codinit-app
56-
```
43+
````
5744

58-
Install Dependencies
45+
### Install Dependencies
5946

6047
```bash
6148
# npm
@@ -67,86 +54,84 @@ pnpm install
6754
# or yarn
6855
yarn install
6956
```
57+
7058
### 2️⃣ Set Up the Database
7159

72-
Ensure you have a PostgreSQL database running. You can use Supabase for a quick setup.
60+
Ensure you have a PostgreSQL database running. (Supabase recommended.)
7361

7462
### 3️⃣ Configure Environment
63+
7564
```bash
7665
cp .env.example .env.local
7766
```
7867

79-
#### Edit .env.local and add your provider keys:
68+
Add your keys:
8069

8170
```bash
8271
OPENAI_API_KEY=your_openai_key
8372
ANTHROPIC_API_KEY=your_anthropic_key
8473
SUPABASE_URL=your_supabase_url
8574
SUPABASE_ANON_KEY=your_supabase_anon_key
8675
```
76+
8777
### 4️⃣ Run the Dev Server
8878

8979
```bash
9080
pnpm run dev
9181
```
9282

93-
The app will be available at 👉 http://localhost:5173
83+
The app will be available at:
84+
👉 [http://localhost:5173](http://localhost:5173)
9485

9586
---
9687

97-
🧩 Key Features
98-
99-
🧠 AI-powered full-stack development for Node.js apps
100-
101-
🌐 Integrations with 19+ AI providers (OpenAI, Anthropic, Google, Groq, etc.)
102-
103-
🖥️ Web and Desktop support (Electron app included)
104-
105-
🐳 Docker-ready and deployable to Vercel, Netlify, or GitHub Pages
106-
107-
🔍 Built-in search, diff view, and file locking system
108-
109-
🧰 Supabase integration, data visualization, and voice prompting
110-
88+
## 🧩 Key Features
11189

90+
* 🧠 AI-powered full-stack development for Node.js apps
91+
* 🌐 Integrations with 19+ AI providers
92+
* 🖥️ Web + Desktop (Electron) support
93+
* 🐳 Docker-ready, deployable to Vercel/Netlify/GitHub Pages
94+
* 🔍 Built-in search, diff view, and file locking system
95+
* 🧰 Supabase integration, data visualization, and voice prompting
11296

11397
---
11498

115-
🔑 API Providers
99+
## 🔑 API Providers
116100

117-
Easily manage API keys via the settings panel or .env.local file.
118-
Supported providers include:
119-
120-
Cloud: OpenAI, Anthropic, Google, Groq, xAI, DeepSeek, Cohere, Mistral, Together, Perplexity, HuggingFace, OpenRouter, and more.
121-
Local: Ollama, LM Studio, OpenAI-compatible endpoints.
101+
**Cloud Providers:**
102+
OpenAI, Anthropic, Google, Groq, xAI, DeepSeek, Cohere, Mistral, Together, Perplexity, HuggingFace, OpenRouter, and more.
122103

104+
**Local:**
105+
Ollama, LM Studio, OpenAI-compatible local endpoints.
123106

124107
---
125108

126-
🖥️ Desktop & Docker Options
109+
## 🖥️ Desktop & Docker Options
127110

128-
Run via Docker
111+
### Run via Docker
129112

113+
```bash
130114
npm run dockerbuild
131115
docker compose --profile development up
116+
```
132117

133-
Run as Desktop App
134-
135-
Download the latest release for your OS:
136-
[👉 CodinIT Releases](https://github.com/Gerome-Elassaad/codinit-app/releases/latest)
118+
### Run as Desktop App
137119

120+
Download the latest release:
121+
👉 [https://github.com/Gerome-Elassaad/codinit-app/releases/latest](https://github.com/Gerome-Elassaad/codinit-app/releases/latest)
138122

139123
---
140124

141-
🤝 Contributing
125+
## 🤝 Contributing
142126

143127
We welcome contributions!
144-
Open an issue, submit a pull request, or join discussions to help improve CodinIT.
128+
Open an issue, submit a PR, or join discussions to help shape the future of CodinIT.dev.
145129

146130
---
147131

148132
<p align="center">
149133
<strong>CodinIT.dev — Build Faster. Code Smarter.</strong><br/>
150-
151134
<a href="https://github.com/Gerome-Elassaad/codinit-app/releases/latest">Download the latest version →</a>
152135
</p>
136+
```
137+

0 commit comments

Comments
 (0)