Skip to content

Commit a38530e

Browse files
updated readme
1 parent ddfd689 commit a38530e

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
</p>
44

55
<p align="center">
6-
<a href="https://huntscreens.com">
7-
<img src="/readme_assets/featured.svg" alt="Featured on HuntScreens" width="240" height="60" loading="lazy" />
8-
</a>
6+
<a href="https://huntscreens.com/en/products/codinit" target="_blank" title="Featured on HuntScreens" aria-label="Featured on HuntScreens">
7+
<img src="https://shot.huntscreens.com/badge.svg" alt="Featured on HuntScreens" width="240" height="60" loading="lazy" />
8+
</a>
99
</p>
1010

1111
<p align="center">
@@ -17,7 +17,7 @@
1717

1818
## 🚀 Quick Start
1919

20-
Get up and running with **CodinIT** in just a few steps.
20+
Get up and running with **CodinIT.dev** in just a few steps.
2121

2222
### 1️⃣ Clone the Repository
2323

@@ -26,8 +26,9 @@ git clone https://github.com/Gerome-Elassaad/codinit-app.git
2626
cd codinit-app
2727
```
2828

29-
2️⃣ Install Dependencies
29+
Install Dependencies
3030

31+
```bash
3132
# npm
3233
npm install
3334

@@ -36,23 +37,32 @@ pnpm install
3637

3738
# or yarn
3839
yarn install
40+
```
41+
### 2️⃣ Set Up the Database
3942

40-
3️⃣ Configure Environment
43+
Ensure you have a PostgreSQL database running. You can use Supabase for a quick setup.
4144

45+
### 3️⃣ Configure Environment
46+
```bash
4247
cp .env.example .env.local
48+
```
4349

44-
Edit .env.local and add your provider keys:
50+
#### Edit .env.local and add your provider keys:
4551

52+
```bash
4653
OPENAI_API_KEY=your_openai_key
4754
ANTHROPIC_API_KEY=your_anthropic_key
55+
SUPABASE_URL=your_supabase_url
56+
SUPABASE_ANON_KEY=your_supabase_anon_key
57+
```
58+
### 4️⃣ Run the Dev Server
4859

49-
4️⃣ Run the Dev Server
50-
60+
```bash
5161
pnpm run dev
62+
```
5263

5364
The app will be available at 👉 http://localhost:5173
5465

55-
5666
---
5767

5868
🧩 Key Features
@@ -108,7 +118,7 @@ Open an issue, submit a pull request, or join discussions to help improve CodinI
108118
---
109119

110120
<p align="center">
111-
<strong>🧠 CodinIT.dev — Build Faster. Code Smarter.</strong><br/>
121+
<strong>CodinIT.dev — Build Faster. Code Smarter.</strong><br/>
112122

113123
<a href="https://github.com/Gerome-Elassaad/codinit-app/releases/latest">Download the latest version →</a>
114124
</p>

0 commit comments

Comments
 (0)