From 37d822b6e33cf8705c18d7f9a1b548465f6a3847 Mon Sep 17 00:00:00 2001 From: B SIMAK AHMED Date: Wed, 23 Sep 2026 20:10:18 +0530 Subject: [PATCH] Revise README for clarity and feature updates Updated README.md to enhance clarity and detail about CodeForge's features, architecture, and development guidelines. --- README.md | 476 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 294 insertions(+), 182 deletions(-) diff --git a/README.md b/README.md index 77bb725..1de8e6e 100644 --- a/README.md +++ b/README.md @@ -2,122 +2,165 @@ > **Forge ideas into reality.** -A modern **personal developer portfolio and technical blog** built to showcase projects, technical work, learning, and AI-powered development. +CodeForge is a modern personal developer platform built to showcase software projects, technical work, learning, technical writing, and AI-powered development. -CodeForge is built with **React, TypeScript, Tailwind CSS, TanStack, Supabase, and PostgreSQL**, with production deployment on **Vercel**. +It combines a developer portfolio, technical blog, AI-powered capabilities, authentication, protected application areas, and a modern full-stack architecture. -🌐 **Live Website:** https://codeforgedev.vercel.app +--- + +## ✨ Features + +* πŸ’Ό Developer portfolio +* πŸš€ Project showcase +* πŸ“ Technical blog +* πŸ”Ž Blog search and discovery +* 🏷️ Categories and tags +* πŸ’¬ Blog comments +* πŸ€– AI-powered developer features +* πŸ” Authentication +* πŸ›‘οΈ Protected application areas +* πŸ‘€ Admin functionality +* πŸ”‘ Password recovery +* πŸ”’ Multi-factor authentication support +* πŸ“¬ Contact functionality +* πŸ“± Responsive user interface +* ⚑ Modern application architecture +* πŸ“Š Data visualization +* ☁️ Vercel deployment +* πŸ“ˆ Vercel Analytics --- -## ✨ Highlights +## 🌐 Live Website -- 🌐 Personal developer portfolio -- πŸ’Ό Project showcase -- πŸ“ Technical blog -- πŸ€– AI-powered development -- πŸ” Authentication -- πŸ›‘οΈ Protected application areas -- πŸ“± Responsive modern UI -- ⚑ Modern frontend architecture -- ☁️ Vercel deployment -- πŸ“š Continuous learning and development +**CodeForge:** https://codeforgedev.vercel.app --- -## 🏠 About CodeForge +# 🏠 About CodeForge -CodeForge is a personal developer platform created to showcase software projects, technical interests, development work, and continuous learning. +CodeForge is a personal developer platform created to bring together software projects, technical articles, development experiments, learning resources, and AI-powered tools in one place. -The platform is built around three core ideas: +The platform focuses on: -**Modern Stack Β· Fast Performance Β· AI Powered** +* Building practical software +* Exploring modern technologies +* Learning through real projects +* Documenting technical knowledge +* Experimenting with AI +* Applying security-conscious development practices -### Current Highlights +### Core Philosophy -| Metric | Value | -|---|---:| -| πŸš€ Projects Built | **6+** | -| πŸ’» Lines of Code | **15K+** | -| πŸ› οΈ Technologies | **5+** | -| πŸ“š Learning | **24/7** | +**Build Β· Learn Β· Experiment Β· Secure** --- -## πŸ’Ό Projects +# πŸ’Ό Portfolio -The Projects section showcases software projects and technical work. +The portfolio section showcases software projects and technical work. -Projects focus on: +Each project can highlight: -- Project purpose -- Key features -- Technologies used -- Technical implementation -- Development approach -- Project outcomes +* Project purpose +* Key features +* Technologies used +* Technical implementation +* Development decisions +* Project status +* Relevant resources -The goal is to showcase practical software engineering and real-world project development. +The goal is to demonstrate practical software engineering rather than simply listing technologies. --- -## πŸ“ Technical Blog +# πŸ“ Technical Blog + +CodeForge includes a technical blog for publishing development-related articles and technical knowledge. -CodeForge includes a dedicated technical blog for sharing technical knowledge and development experiences. +### Blog Capabilities -### Blog Features +* Technical articles +* Individual article pages +* Search +* Categories +* Tags +* Markdown content +* GitHub-flavored Markdown +* Comments +* Content management +* Responsive reading experience -- Technical articles -- Individual article pages -- Search functionality -- Categories and tags -- Markdown-based content -- Comments -- Content management +### Topics -The blog is designed to support technical writing, documentation, and knowledge sharing. +Blog content can cover areas such as: + +* Programming +* Artificial Intelligence +* Cybersecurity +* Web Development +* Databases +* Cloud Computing +* Computer Networks +* Software Engineering +* Developer Tools +* Technical Learning --- -## πŸ€– AI-Powered Development +# πŸ€– AI-Powered Development + +AI is one of the major areas explored by CodeForge. -AI is one of the core themes of CodeForge. +The project uses modern AI technologies to experiment with developer-focused and productivity-oriented workflows. -The project explores AI-powered development alongside traditional software engineering. +Areas of exploration include: -Areas of interest include: +* Artificial Intelligence +* Generative AI +* Large Language Models +* AI-assisted development +* AI developer tools +* Prompt engineering +* Intelligent automation +* AI-powered applications +* AI-assisted learning -- Artificial Intelligence -- Machine Learning -- Generative AI -- LLM-powered applications -- AI developer tools -- Prompt engineering -- Intelligent automation +The AI capabilities of CodeForge are continuously evolving as new ideas and technologies are explored. --- -## πŸ” Authentication & Security +# πŸ” Authentication & Security -CodeForge includes authentication and protected application functionality. +Security is an important part of the CodeForge architecture. -### Authentication +## Authentication -- Email and password authentication -- Supabase Authentication -- Protected routes -- Session-aware application flow -- Multi-factor authentication support +CodeForge uses Supabase Authentication and application-level access control. -### Security +Authentication functionality includes: -- Environment-based configuration -- Protected application areas -- PostgreSQL-backed data -- Authentication-aware application flows -- Sensitive credentials kept outside the repository +* Email and password authentication +* Session management +* Protected routes +* Password recovery +* Authentication-aware application flows +* Multi-factor authentication support +* Protected administrative functionality -> ⚠️ Never commit production credentials, service-role keys, private API keys, or other secrets to the repository. +## Security Practices + +The project follows security-conscious development practices including: + +* Environment-based configuration +* Protected application areas +* Authentication-aware access control +* Database-backed authorization +* Separation of public and privileged functionality +* Server-side handling of sensitive operations +* Secrets kept outside the repository + +> ⚠️ Never commit production credentials, service-role keys, private API keys, access tokens, or other secrets to the repository. --- @@ -125,84 +168,103 @@ CodeForge includes authentication and protected application functionality. ## Frontend -- **React 19** -- **TypeScript** -- **Vite** -- **TanStack Router** -- **TanStack Start** -- **Tailwind CSS** -- **shadcn/ui** -- **Radix UI** -- **Framer Motion** -- **Lucide React** +* **React 19** +* **TypeScript** +* **Vite** +* **TanStack Router** +* **TanStack Start** +* **Tailwind CSS** +* **shadcn/ui** +* **Radix UI** +* **Framer Motion** +* **Lucide React** ## Backend & Database -- **Supabase** -- **PostgreSQL** -- **Supabase Authentication** +* **Supabase** +* **PostgreSQL** +* **Supabase Authentication** ## AI -- **AI SDK** -- **AI integrations** +* **Vercel AI SDK** +* **OpenAI-compatible AI integrations** ## Forms & Validation -- **React Hook Form** -- **Zod** +* **React Hook Form** +* **Zod** ## Content -- **React Markdown** -- **remark-gfm** +* **React Markdown** +* **remark-gfm** + +## Data & Visualization + +* **TanStack Query** +* **Recharts** +* **date-fns** -## Data & UI +## UI & Utilities -- **TanStack Query** -- **Recharts** -- **date-fns** -- **Sonner** +* **Sonner** +* **Embla Carousel** +* **Tailwind Merge** +* **Class Variance Authority** -## Deployment +## Email -- **Vercel** +* **Resend** + +## Deployment & Analytics + +* **Vercel** +* **Vercel Analytics** --- # πŸ—οΈ Architecture ```text - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ CodeForge β”‚ - β”‚ Portfolio + Technical β”‚ - β”‚ Blog β”‚ - β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - β”‚ - β–Ό - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ React + TypeScript β”‚ - β”‚ TanStack + Tailwind β”‚ - β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - β”‚ - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ β”‚ - β–Ό β–Ό - Public Experience Protected Areas - β”‚ β”‚ - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” Authentication - β”‚ β”‚ β”‚ β”‚ - β–Ό β–Ό β–Ό β–Ό - Portfolio Projects Blog Admin - β”‚ - β–Ό - Supabase - β”‚ - β–Ό - PostgreSQL - β”‚ - β–Ό - Vercel + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ CodeForge β”‚ + β”‚ Portfolio + Blog + AI β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ React + TypeScript β”‚ + β”‚ TanStack + Tailwind CSS β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ + β–Ό β–Ό + Public Experience Protected Experience + β”‚ β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ β”‚ β”‚ β”‚ + β–Ό β–Ό β–Ό β–Ό β–Ό + Portfolio Blog AI Authentication Admin + β”‚ β”‚ β”‚ β”‚ β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Supabase β”‚ + β”‚ Auth + Databaseβ”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ PostgreSQL β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Vercel β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` --- @@ -214,12 +276,23 @@ CodeForge/ β”‚ β”œβ”€β”€ .main/ β”‚ └── project.json +β”‚ β”œβ”€β”€ migration/ +β”‚ β”œβ”€β”€ public/ +β”‚ +β”œβ”€β”€ scripts/ +β”‚ β”œβ”€β”€ src/ +β”‚ β”œβ”€β”€ components/ +β”‚ β”œβ”€β”€ lib/ +β”‚ β”œβ”€β”€ routes/ +β”‚ └── ... +β”‚ β”œβ”€β”€ supabase/ β”‚ β”œβ”€β”€ migrations/ β”‚ └── config.toml +β”‚ β”œβ”€β”€ .env.example β”œβ”€β”€ .gitignore β”œβ”€β”€ .prettierignore @@ -236,43 +309,57 @@ CodeForge/ └── vite.config.ts ``` +> The project structure may evolve as new features are added. + --- # πŸš€ Getting Started ## Prerequisites -Make sure you have: +Before running CodeForge locally, make sure you have: + +* Node.js +* npm +* A Supabase project -- Node.js -- npm -- A Supabase project +--- -### 1. Clone the Repository +## 1. Clone the Repository ```bash git clone https://github.com/SamRepository25/CodeForge.git cd CodeForge ``` -### 2. Install Dependencies +--- + +## 2. Install Dependencies ```bash npm install ``` -### 3. Configure Environment Variables +--- + +## 3. Configure Environment Variables -Create a `.env` file in the project root: +Create a `.env` file in the project root. + +Example: ```env VITE_SUPABASE_URL=your_supabase_project_url VITE_SUPABASE_ANON_KEY=your_supabase_anon_key ``` -> ⚠️ Never commit your real credentials or private keys to GitHub. +Additional environment variables may be required for server-side, AI, email, or other integrations depending on the enabled features. + +> ⚠️ Never commit your real `.env` file or production secrets. -### 4. Start the Development Server +--- + +## 4. Start the Development Server ```bash npm run dev @@ -284,37 +371,37 @@ The development server will provide a local URL. # πŸ§ͺ Development Commands -### Start Development Server +## Start Development Server ```bash npm run dev ``` -### Build for Production +## Production Build ```bash npm run build ``` -### Development Build +## Development Build ```bash npm run build:dev ``` -### Preview Production Build +## Preview Production Build ```bash npm run preview ``` -### Run Linter +## Run ESLint ```bash npm run lint ``` -### Format Code +## Format Code ```bash npm run format @@ -326,70 +413,99 @@ npm run format CodeForge is deployed using **Vercel**. +The production application is connected to the GitHub repository and is continuously maintained as the project evolves. + ### Production Website https://codeforgedev.vercel.app -The production application is connected to the CodeForge GitHub repository. +--- + +# πŸ”’ Security Guidelines + +When developing or deploying CodeForge: + +* Never commit `.env` files containing secrets. +* Never expose Supabase service-role credentials to the browser. +* Never commit private API keys. +* Keep privileged operations on trusted server-side boundaries. +* Validate user-controlled input. +* Use appropriate authentication and authorization checks. +* Review database access policies before changing protected functionality. +* Avoid exposing sensitive application information through client-side code. +* Test authentication and authorization changes carefully. + +Security changes should be treated as application-wide changes because authentication, database policies, protected routes, and administrative functionality can depend on one another. --- -# πŸ“Έ Screenshots +# 🧠 Development Philosophy -### 🏠 Home +CodeForge is built around four principles. -CodeForge Home +### πŸš€ Build -### πŸ‘¨β€πŸ’» About +Turn ideas into working software. -CodeForge About +### πŸ“š Learn -### πŸ’Ό Projects +Use real projects and experimentation to develop practical technical knowledge. -CodeForge Projects +### πŸ€– Explore -### πŸ“ Blog +Experiment with emerging technologies, especially AI and modern developer tooling. -CodeForge Blog +### πŸ” Secure + +Treat security, privacy, authorization, and maintainability as part of the development process. --- -# πŸ—ΊοΈ Future Improvements +# πŸ—ΊοΈ Roadmap + +CodeForge is an actively evolving project. Potential future improvements include: -- [ ] Expanded AI-powered features -- [ ] AI chat capabilities -- [ ] Portfolio analytics -- [ ] Advanced blog search -- [ ] Automated testing -- [ ] Performance optimization -- [ ] Progressive Web App support -- [ ] Additional security hardening -- [ ] More technical articles -- [ ] Expanded project case studies -- [ ] Accessibility improvements +* [ ] Additional AI-powered tools +* [ ] AI chat capabilities +* [ ] Expanded developer utilities +* [ ] More technical articles +* [ ] Expanded project case studies +* [ ] Advanced blog search +* [ ] Portfolio analytics +* [ ] Automated testing +* [ ] Performance optimization +* [ ] Accessibility improvements +* [ ] Additional security hardening +* [ ] Progressive Web App capabilities +* [ ] Additional developer-focused features + +The roadmap may change as the project evolves. --- # 🀝 Contributing -CodeForge is primarily a personal project, but feedback, suggestions, bug reports, and feature requests are welcome. +CodeForge is primarily a personal project. + +Feedback, suggestions, bug reports, and feature requests are welcome. -If you discover an issue: +If you discover a problem: 1. Open a GitHub Issue. -2. Clearly describe the problem. +2. Clearly describe the issue. 3. Include reproduction steps when possible. 4. Add screenshots or logs when useful. +5. Never include passwords, API keys, tokens, or other secrets. --- # πŸ“„ License -This project is licensed under the **Proprietary License**. +CodeForge is licensed under the **Proprietary License**. -See the [**LICENSE**](./LICENSE) file for details. +See the [`LICENSE`](./LICENSE) file for the applicable terms. --- @@ -401,17 +517,13 @@ See the [**LICENSE**](./LICENSE) file for details. ### Interests -- Software Development -- Artificial Intelligence -- Cybersecurity -- Full-Stack Development -- Developer Tools -- Modern Web Technologies - -### Links - -- **GitHub:** https://github.com/SamRepository25 -- **CodeForge:** https://codeforgedev.vercel.app +* πŸ’» Software Development +* πŸ€– Artificial Intelligence +* πŸ” Cybersecurity +* 🌐 Full-Stack Development +* πŸ› οΈ Developer Tools +* ☁️ Cloud Technologies +* 🌍 Modern Web Technologies ---