From c8f5d564eb3c126991b9035cd0bdca6355d2dcc2 Mon Sep 17 00:00:00 2001 From: skullxcode Date: Sat, 13 Jun 2026 12:58:55 +0530 Subject: [PATCH] docs: update README with environment setup, latest projects, and features --- README.md | 72 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 255ba70..8c5a7ad 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,82 @@ # DemonDie Website [![GitHub](https://img.shields.io/badge/GitHub-Demon--Die-181717?style=for-the-badge&logo=github)](https://github.com/Demon-Die) -[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/yWtjK2Tb8T) +[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/4waT35Hxs) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)](https://github.com/Demon-Die/Website?tab=MIT-1-ov-file) -[![Contributing](https://img.shields.io/badge/Contributing-Guide-2ea44f?style=for-the-badge)](https://github.com/Demon-Die/Website?tab=contributing-ov-file) -[![Code of Conduct](https://img.shields.io/badge/Code%20of%20Conduct-ff69b4?style=for-the-badge)](https://github.com/Demon-Die/Website?tab=coc-ov-file) Professional static website for the DemonDie organization. Designed with Google Stitch, Connected by hands, Styled with TailwindCss. -## Current Project +## 🚀 Projects Highlight ### Demon Tech Roadmap - -Community-driven learning roadmaps for students and aspiring developers. - -Demon Tech Roadmap is an open-source platform designed to help learners navigate technology careers through structured, beginner-friendly roadmaps, curated resources, and practical project recommendations. - +Community-driven learning roadmaps for students and aspiring developers. Designed to help learners navigate technology careers through structured, beginner-friendly roadmaps, curated resources, and practical project recommendations. - Repository: [github.com/Demon-Die/DemonTechRoadmap](https://github.com/Demon-Die/DemonTechRoadmap) - Website: [demon-tech-roadmap.vercel.app](https://demon-tech-roadmap.vercel.app/) -## Local Development +### UnVibe +UnVibe trains developers to truly understand code, not just generate it. +- Repository: [github.com/Demon-Die/unvibe](https://github.com/Demon-Die/unvibe) + +### SyncCanvas +An AI-powered collaborative whiteboard for real-time brainstorming, diagramming, and team collaboration on an infinite canvas. +- Repository: [github.com/Demon-Die/SyncCanvas](https://github.com/Demon-Die/SyncCanvas) -This repository is a static website, so there is no Node install or build step required. +--- + +## 💻 Local Development + +This repository is a static website, so there is no Node install or build step required. The site relies on the Tailwind CDN and Vanilla CSS. + +### 1. Environment Setup +To run the website fully (including GitHub stats, Supabase integration, and Firebase Authentication), you need to configure your environment variables. +Copy the provided `.env.example` or create a new `env.json` and `.env` file in the root directory with your Firebase, Supabase, and GitHub configuration: + +```json +{ + "FIREBASE_API_KEY": "YOUR_API_KEY", + "FIREBASE_AUTH_DOMAIN": "YOUR_AUTH_DOMAIN", + "FIREBASE_PROJECT_ID": "YOUR_PROJECT_ID", + "FIREBASE_STORAGE_BUCKET": "YOUR_STORAGE_BUCKET", + "FIREBASE_MESSAGING_SENDER_ID": "YOUR_MESSAGING_SENDER_ID", + "FIREBASE_APP_ID": "YOUR_APP_ID", + "GIT_DEMONDIE_ALL": "YOUR_GITHUB_TOKEN", + "SUPABASE_URL": "YOUR_SUPABASE_URL", + "SUPABASE_ANON_KEY": "YOUR_SUPABASE_KEY" +} +``` -1. Start a local web server from the repository root: +### 2. Start Local Server +Because the website fetches local JSON and module files, you must serve it over HTTP (opening `index.html` directly in the browser may cause CORS issues). ```bash # Clone the repo git clone https://github.com/Demon-Die/Website.git cd Website -# No build step – open locally -open index.html # macOS -# or serve with any static server -npx -y serve . # quick local dev server +# Start a local web server (e.g. using npx) +npx -y http-server -p 8080 ``` -The site relies on the Tailwind CDN, so no npm install is required. +Open `http://localhost:8080` in your browser. --- -## ▶️ Usage -- Open `index.html` in a browser. -- The navigation links (`Home`, `Projects`, `Contributors`, `Community`, `About`) scroll smoothly to their sections. -- Click the **“Join the contributors”** card to open the GitHub organization members page. +## ▶️ Features & Usage +- **Dynamic Content**: Fetches recent activity, contributor stats, and repository details directly via the GitHub API. +- **Firebase Authentication**: Integrated Google & GitHub OAuth. Authorized maintainers can log in to access admin-only features (e.g., adding blogs). +- **Responsive Layout**: Designed to adapt perfectly to mobile, tablet, and desktop screens. --- ## 🤝 Contributing We welcome contributions! To get started: 1. Fork the repository. -2. Create a feature branch (`git checkout -b feat/awesome‑feature`). +2. Create a feature branch (`git checkout -b feat/awesome-feature`). 3. Make your changes – keep the existing design language consistent. 4. Open a Pull Request describing the improvement. -Please follow the existing code style (Tailwind utility classes, BEM‑like naming, and the custom color palette defined in the `