Skip to content

Commit 7177ec9

Browse files
committed
Recursive file tree support in backend,Backend reliability upgrades in main.py,Sanitized leaked secrets in .env.
1 parent e99092a commit 7177ec9

8 files changed

Lines changed: 583 additions & 307 deletions

File tree

.env.example

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
APP_ENV=development
2+
SECRET_KEY=replace-with-a-long-random-string
3+
GITHUB_CLIENT_ID=your_github_client_id
4+
GITHUB_CLIENT_SECRET=your_github_client_secret
5+
GITHUB_TOKEN=your_github_token
6+
OLLAMA_URL=http://127.0.0.1:11434
7+
CELERY_BROKER_URL=redis://localhost:6379/0
8+
CELERY_RESULT_BACKEND=redis://localhost:6379/0

README.md

Lines changed: 46 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
1-
# 🚀 CodeScribeAI
1+
# 🚀 CodeScribeAI
22

3-
🚧 Note: The Project is in development
3+
🚧 Note: The Project is in development
44
<br>
55
**CodeScribeAI** is an AI-powered coding assistant that helps you **explore, debug, and understand code** effortlessly.
6-
Built with **React**, **Node.js**, and **Ollama LLM**, it’s designed to boost developer productivity and make coding more intuitive.
6+
Built with **React**, **Node.js**, and **Ollama LLM**, it’s designed to boost developer productivity and make coding more intuitive.
77

88
---
99

10-
## Features
10+
## ✨ Features
1111

12-
- 🤖 **AI-Powered Assistance** Get instant explanations, debugging help, and code insights.
13-
- 📂 **File Analysis** Upload or select files for detailed breakdowns.
14-
- 💡 **Smart Suggestions** Improve your code with AI-driven recommendations.
15-
- 🎨 **Clean UI** Minimal and distraction-free interface built with React + Tailwind.
16-
- 🛠️ **Extensible Backend** Node.js + Express API with modular routes.
17-
- 🔒 **In Progress** Actively being developed with new features coming soon!
12+
- 🤖 **AI-Powered Assistance** – Get instant explanations, debugging help, and code insights.
13+
- 📂 **File Analysis** – Upload or select files for detailed breakdowns.
14+
- 💡 **Smart Suggestions** – Improve your code with AI-driven recommendations.
15+
- 🎨 **Clean UI** – Minimal and distraction-free interface built with React + Tailwind.
16+
- 🛠️ **Extensible Backend** – Node.js + Express API with modular routes.
17+
- 🔒 **In Progress** – Actively being developed with new features coming soon!
1818

1919
---
2020

21-
## 🛠️ Tech Stack
21+
## 🛠️ Tech Stack
2222

2323
**Frontend**
24-
- ⚛️ React
25-
- 🎨 Tailwind CSS
26-
- 🔄 React Router
27-
- GSAP (animations)
24+
- ⚛️ React
25+
- 🎨 Tailwind CSS
26+
- 🔄 React Router
27+
- ✨ GSAP (animations)
2828

2929
**Backend**
30-
- 🟢 Node.js + Express
31-
- 🗄️ MySQL2 (with SSL for DigitalOcean)
32-
- 📦 Multer (file uploads)
33-
- 📧 Nodemailer (email handling)
30+
- 🟢 Node.js + Express
31+
- 🗄️ MySQL2 (with SSL for DigitalOcean)
32+
- 📦 Multer (file uploads)
33+
- 📧 Nodemailer (email handling)
3434

3535
**AI**
36-
- 🧠 [Ollama](https://ollama.ai) Local LLM integration
36+
- 🧠 [Ollama](https://ollama.ai) – Local LLM integration
3737

3838
---
3939

40-
## 🚀 Getting Started
40+
## 🚀 Getting Started
4141

4242
Follow these steps to set up CodeScribeAI locally:
4343

44-
### 1️⃣ Clone the Repository
44+
### 1️⃣ Clone the Repository
4545
```bash
4646
git clone https://github.com/your-username/codescribeAI.git
4747
cd codescribeAI
4848
```
49-
### 2️⃣ Install Dependencies
49+
### 2️⃣ Install Dependencies
5050
```bash
5151
Frontend:
5252
cd frontend
@@ -56,16 +56,23 @@ cd backend
5656
npm install
5757
```
5858
### 3️⃣ Configure Environment
59-
Create .env files in both frontend/ and backend/ with required configs:
60-
backend .env
59+
Copy `.env.example` to `.env` and fill values:
6160
```bash
62-
GITHUB_CLIENT_ID= github_client_id
63-
GITHUB_CLIENT_SECRET= github_client_secret
64-
GITHUB_TOKEN= github_token
65-
OLLAMA_URL= ollama_url
66-
61+
cp .env.example .env
62+
```
63+
Required values:
64+
```bash
65+
APP_ENV=development
66+
SECRET_KEY=replace-with-a-long-random-string
67+
GITHUB_CLIENT_ID=your_github_client_id
68+
GITHUB_CLIENT_SECRET=your_github_client_secret
69+
GITHUB_TOKEN=your_github_token
70+
OLLAMA_URL=http://127.0.0.1:11434
6771
```
68-
### 4️⃣ Run the Project
72+
Security notes:
73+
- Never commit `.env` to git.
74+
- Rotate secrets immediately if they were ever shared.
75+
### 4️⃣ Run the Project
6976
Start backend:
7077
```bash
7178
cd backend
@@ -77,7 +84,7 @@ npm run dev
7784

7885
---
7986

80-
## 📌 Roadmap
87+
## 📌 Roadmap
8188
AI-powered debugging suggestions
8289

8390
Multi-file context awareness
@@ -88,7 +95,7 @@ npm run dev
8895

8996
Authentication & user profiles
9097

91-
## 🤝 Contributing
98+
## 🤝 Contributing
9299
Contributions are welcome!
93100

94101
Fork the repo
@@ -99,14 +106,15 @@ Commit changes (git commit -m "Add feature")
99106

100107
Push to your branch (git push origin feature-name)
101108

102-
Open a Pull Request 🎉
109+
Open a Pull Request 🎉
103110

104-
## 📜 License
111+
## 📜 License
105112
This project is licensed under the MIT License.
106113
See the LICENSE file for details.
107114

108-
## 🌟 Support
109-
If you like this project, please consider giving it a ⭐ on GitHub – it helps a lot!
115+
## 🌟 Support
116+
If you like this project, please consider giving it a ⭐ on GitHub – it helps a lot!
117+
118+
## 📸 Screenshots (Coming Soon)
110119

111-
## 📸 Screenshots (Coming Soon)
112120

0 commit comments

Comments
 (0)