git:fixed conflict

Author: 0xarg

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenScope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,37 +1,217 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# OpenScope
 
-## Getting Started
+OpenScope is a developer-focused tool that helps you **discover, understand, and track open‑source issues** with clarity and confidence.
 
-First, run the development server:
+Reading through long GitHub issues, discussions, and repositories can be overwhelming—especially when you’re just getting started. OpenScope cuts through that noise by analyzing repositories and issues and presenting only what actually matters, so you can decide *where to contribute* and *how to begin*.
 
+This project is built primarily for:
+- Developers preparing for programs like **GSoC**
+- First‑time and regular open‑source contributors
+- Anyone looking to evaluate issues before investing time
+
+---
+
+## Live Demo
+
+- **Production**: https://openscope.anuragx.dev  
+- **Demo mode**: Available inside the app (no GitHub login required)
+
+---
+
+## What OpenScope Does
+
+### Repository & Issue Browsing
+- Fetch repositories and issues directly from GitHub
+- Clean, distraction‑free interface focused on readability
+
+### AI‑Generated Insights
+For every issue, OpenScope generates:
+- A clear **summary** of the problem
+- **Difficulty level** (easy / medium / hard)
+- **Required skills** and knowledge areas
+- A practical **suggested approach**
+- **Estimated time** to work on the issue
+- A **match score** based on your profile
+
+The goal is not to replace your judgment—but to help you make better decisions faster.
+
+### Issue Tracking
+- Save issues you’re interested in
+- View all tracked issues in one place
+- Avoid duplicate tracking automatically
+
+### GitHub Authentication
+- Secure login using GitHub OAuth
+- Automatically syncs your GitHub profile
+
+### Usage Limits & Plans
+- Free, Pro, and Premium plans
+- AI usage limits enforced on the backend
+- Clear UI feedback when limits are reached
+
+---
+
+## Tech Stack
+
+### Frontend
+- Next.js (App Router)
+- React
+- TypeScript
+- Tailwind CSS
+- Radix UI
+
+### Backend
+- Next.js API Routes
+- Prisma ORM
+- PostgreSQL (Neon)
+
+### Authentication
+- NextAuth.js
+- GitHub OAuth
+
+### AI
+- OpenRouter API
+- OpenAI‑compatible models
+
+### DevOps & Infrastructure
+- Docker
+- GitHub Actions (CI/CD)
+- DigitalOcean (production hosting)
+
+---
+
+## Architecture Overview
+
+```
+Local Machine
+└─ git push
+
+GitHub Actions (CI)
+├─ install dependencies
+├─ build Next.js app
+├─ build Docker image
+├─ export image
+└─ copy image to server
+
+Production Server (DigitalOcean)
+├─ load Docker image
+└─ run container
+```
+
+Builds happen entirely in CI.  
+The server only runs containers—no builds, no installs.
+
+This approach:
+- Reduces RAM usage on the server
+- Avoids broken SSH sessions during builds
+- Makes deployments predictable and repeatable
+
+---
+
+## Local Development
+
+### 1. Clone the repository
+```bash
+git clone https://github.com/0xarg/openscope.git
+cd openscope
+```
+
+### 2. Install dependencies
+```bash
+pnpm install
+```
+
+### 3. Configure environment variables
+
+Create a `.env.local` file:
+
+```env
+DATABASE_URL=postgresql://...
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=your-secret
+
+GITHUB_ID=your_github_oauth_id
+GITHUB_SECRET=your_github_oauth_secret
+
+OPENROUTER_API_KEY=your_openrouter_api_key
+```
+
+### 4. Run the app
 ```bash
-npm run dev
-# or
-yarn dev
-# or
 pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+The app will be available at:
+```
+http://localhost:3000
+```
+
+---
+
+## Production Deployment
+
+OpenScope is deployed using **GitHub Actions + Docker**.
+
+Core principles:
+- No builds on the production server
+- CI is responsible for building images
+- The server only runs containers
+
+Deployment is triggered automatically on:
+```bash
+git push origin main
+```
+
+---
+
+## Security Notes
+
+- All secrets are stored in GitHub Actions Secrets
+- Production environment variables exist only on the server
+- No credentials are committed to the repository
+
+---
+
+## Demo Video
+
+A short walkthrough demo covers:
+- Authentication flow
+- Repository and issue browsing
+- AI‑generated insights
+- Issue tracking workflow
+
+(The video is linked from the website / portfolio.)
+
+---
+
+## Roadmap
+
+Planned improvements:
+- Team and organization support
+- Smarter issue recommendations
+- Token‑based AI usage limits
+- Export insights as Markdown
+- Public API access
+
+---
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Contributing
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+Contributions are welcome.
 
-## Learn More
+1. Fork the repository  
+2. Create a feature branch  
+3. Open a pull request  
 
-To learn more about Next.js, take a look at the following resources:
+---
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+## License
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+MIT License
 
-## Deploy on Vercel
+---
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Author
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for smore details.
-CI/CD enabled
+Built by **Anurag**  
+Focused on open‑source, Web3, and developer tooling.