Skip to content

Commit 5482c5d

Browse files
Revise README for improved content and structure
Updated README to enhance clarity and include new links.
1 parent 44c61c0 commit 5482c5d

1 file changed

Lines changed: 54 additions & 71 deletions

File tree

README.md

Lines changed: 54 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
2-
<img width="1270" height="630" alt="hero-image" src="https://github.com/user-attachments/assets/7d522f08-bbab-47ee-a47f-0b9c92445cdc" />
3-
4-
51
<p align="center">
6-
<a href="https://huntscreens.com/en/products/codinit" target="_blank" title="Featured on HuntScreens">
7-
<img src="https://shot.huntscreens.com/badge.svg" alt="Featured on HuntScreens" width="240" height="60"/>
2+
<img width="1270" height="630" alt="CodinIT.dev Hero" src="https://github.com/user-attachments/assets/7d522f08-bbab-47ee-a47f-0b9c92445cdc" />
3+
</p><p align="center">
4+
<a href="https://fazier.com/launches/codinit" target="_blank">
5+
<img src="https://fazier.com/api/v1/public/badges/embed_image.svg?launch_id=6267&badge_type=weekly&theme=light" width="270" alt="Fazier badge" />
86
</a>
97
<br/><br/>
108
<a href="https://sourceforge.net/projects/codinit-dev/files/latest/download">
@@ -14,115 +12,100 @@
1412
height="48"
1513
srcset="https://a.fsdn.com/con/app/sf-download-button?button_size=2x 2x">
1614
</a>
15+
</p><p align="center">
16+
<strong>⚡ CodinIT.dev — Open‑Source AI App Builder ⚡</strong><br/>
17+
Build, manage, and deploy intelligent applications faster — directly from your browser or desktop.
1718
</p>
19+
---
20+
21+
✨ What is CodinIT.dev?
22+
23+
CodinIT.dev is an open‑source, AI‑powered full‑stack development platform designed to help you build modern Node.js applications with speed and precision. It combines code generation, project management, and deployment tools into a single workflow — powered by your choice of AI providers.
24+
25+
Whether you’re prototyping, scaling a SaaS product, or experimenting with local LLMs, CodinIT.dev adapts to your stack and your workflow.
1826

19-
<p align="center">
20-
<strong>⚡ CodinIT.dev — OpenSource AI App Builder ⚡</strong><br/>
21-
Build, manage, and deploy intelligent applications directly from your browser or desktop.
22-
</p>
2327

2428
---
2529

26-
## 🚀 Quick Start
30+
🚀 Quick Start
2731

28-
Get up and running with **CodinIT.dev** in just a few steps.
32+
Get up and running in minutes.
2933

30-
### 1️⃣ Clone the Repository
34+
1️⃣ Clone the Repository
3135

32-
```bash
3336
git clone https://github.com/codinit-dev/codinit-dev.git
34-
cd codinit-app
35-
````
37+
cd codinit-dev
3638

37-
### Install Dependencies
39+
2️⃣ Install Dependencies
3840

39-
```bash
4041
# npm
4142
npm install
4243

4344
# or pnpm
4445
pnpm install
4546

46-
# or yarn
47-
yarn install
48-
```
47+
3️⃣ Configure Environment
4948

50-
### 2️⃣ Set Up the Database
49+
Create a .env file and add your preferred AI provider keys:
5150

52-
Ensure you have a PostgreSQL database running. (Supabase recommended.)
51+
OPENAI_API_KEY=your_key_here
52+
ANTHROPIC_API_KEY=your_key_here
5353

54-
### 3️⃣ Configure Environment
54+
(You can mix and match multiple providers.)
5555

56-
```bash
57-
cp .env.example .env.local
58-
```
56+
4️⃣ Run the Dev Server
5957

60-
Add your keys:
58+
pnpm run dev
6159

62-
```bash
63-
OPENAI_API_KEY=your_openai_key
64-
ANTHROPIC_API_KEY=your_anthropic_key
65-
SUPABASE_URL=your_supabase_url
66-
SUPABASE_ANON_KEY=your_supabase_anon_key
67-
```
60+
The app will be available at: 👉 http://localhost:5173
6861

69-
### 4️⃣ Run the Dev Server
7062

71-
```bash
72-
pnpm run dev
73-
```
63+
---
7464

75-
The app will be available at:
76-
👉 [http://localhost:5173](http://localhost:5173)
65+
🧩 Key Features
7766

78-
---
67+
🧠 AI‑powered full‑stack development for Node.js apps
7968

80-
## 🧩 Key Features
69+
🌐 19+ AI provider integrations (cloud & local)
8170

82-
* 🧠 AI-powered full-stack development for Node.js apps
83-
* 🌐 Integrations with 19+ AI providers
84-
* 🖥️ Web + Desktop (Electron) support
85-
* 🐳 Docker-ready, deployable to Vercel/Netlify/GitHub Pages
86-
* 🔍 Built-in search, diff view, and file locking system
87-
* 🧰 Supabase integration, data visualization, and voice prompting
71+
🖥️ Web + Desktop (Electron) support
8872

89-
---
73+
🐳 Docker‑ready — deploy to Vercel, Netlify, or GitHub Pages
74+
75+
🔍 Built‑in search, diff viewer & file‑locking
9076

91-
## 🔑 API Providers
77+
🧰 Supabase integration, data visualization & voice prompting
78+
79+
🔐 Provider‑agnostic architecture — no vendor lock‑in
9280

93-
**Cloud Providers:**
94-
OpenAI, Anthropic, Google, Groq, xAI, DeepSeek, Cohere, Mistral, Together, Perplexity, HuggingFace, OpenRouter, and more.
9581

96-
**Local:**
97-
Ollama, LM Studio, OpenAI-compatible local endpoints.
9882

9983
---
10084

101-
## 🖥️ Desktop & Docker Options
85+
🔑 Supported AI Providers
10286

103-
### Run via Docker
87+
☁️ Cloud Providers
10488

105-
```bash
106-
npm run dockerbuild
107-
docker compose --profile development up
108-
```
89+
OpenAI · Anthropic · Google · Groq · xAI · DeepSeek · Cohere · Mistral · Together · Perplexity · HuggingFace · OpenRouter · and more
90+
91+
🏠 Local Providers
92+
93+
Ollama · LM Studio · OpenAI‑compatible local endpoints
10994

110-
### Run as Desktop App
95+
Use one provider or switch dynamically per task.
11196

112-
Download the latest release:
113-
👉 [Latest Release](https://github.com/codinit-dev/codinit-dev/releases/latest)
11497

11598
---
11699

117-
## 🤝 Contributing
100+
🖥️ Desktop & Docker Usage
118101

119-
We welcome contributions!
120-
Open an issue, submit a PR, or join discussions to help shape the future of CodinIT.dev.
102+
Run with Docker
121103

122-
---
104+
npm run dockerbuild
105+
docker compose --profile development up
123106

124-
<p align="center">
125-
<strong>CodinIT.dev — Build Faster. Code Smarter.</strong><br/>
126-
<a href="https://codinit.dev/download">Download the latest version →</a>
127-
</p>
107+
Run as a Desktop App
108+
109+
Download the latest prebuilt release: 👉 https://github.com/codinit-dev/codinit-dev/releases/latest
128110

111+
Available for macOS, Windows, and Linux.

0 commit comments

Comments
 (0)