-
-
Notifications
You must be signed in to change notification settings - Fork 82
docs: improve setup & contributing guide and add .env.example files #132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Sarthakkad05
wants to merge
20
commits into
AOSSIE-Org:main
Choose a base branch
from
Sarthakkad05:docs/setup-cleanup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 13 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
5779408
Update README.md
Sarthakkad05 cd4dbdb
Update README.md
Sarthakkad05 7de762b
Update README.md
Sarthakkad05 de1dbf6
Update README.md
Sarthakkad05 90a462c
Update README.md
Sarthakkad05 59783b9
Update README.md
Sarthakkad05 619496f
Create CONTRIBUTING.md
Sarthakkad05 f55ab6e
Update CONTRIBUTING.md
Sarthakkad05 9f6f618
Update CONTRIBUTING.md
Sarthakkad05 90ad41f
Add architecture and data flow documentation
Sarthakkad05 c04a0d2
Add Contributor Covenant Code of Conduct
Sarthakkad05 0e8d04e
Create .env.example
Sarthakkad05 140f42b
Add example environment configuration file
Sarthakkad05 8f859f9
Update example environment variables with comments
Sarthakkad05 5dfc0d8
Update CONTRIBUTING.md
Sarthakkad05 1eaf1f7
Add comment for NEXT_PUBLIC_API_URL in .env.example
Sarthakkad05 85a9222
Fix link to CONTRIBUTING.md and add ARCHITECTURE note
Sarthakkad05 ab5a7ec
Fix link to ARCHITECTURE.md in README
Sarthakkad05 641e2e8
Enhance Discord invite link in README
Sarthakkad05 b13e64e
Rename .env.example to .example.env
Sarthakkad05 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
|
|
||
| ## Architecture Diagram | ||
|
|
||
|
|
||
| This document explains the internal design and workflow of Perspective. | ||
|
|
||
| Perspective follows a simple client–server architecture where: | ||
| - The frontend handles user interaction | ||
| - The backend processes content | ||
| - AI services generate counter-perspectives | ||
| - A vector database enables semantic retrieval | ||
|
|
||
| ```mermaid | ||
| graph TB | ||
| %% Define Subgraphs with Colors and Text Styles | ||
| subgraph Client Side | ||
| style UI fill:#FFDDC1,stroke:#FF6600,stroke-width:2px,color:#000,font-weight:bold | ||
| UI[Next.js UI] | ||
| end | ||
|
|
||
| subgraph Server Side | ||
| style API fill:#D1E8FF,stroke:#005BBB,stroke-width:2px,color:#000,font-weight:bold | ||
| style Analyzer fill:#D1E8FF,stroke:#005BBB,stroke-width:2px,color:#000,font-weight:bold | ||
| style CNEngine fill:#D1E8FF,stroke:#005BBB,stroke-width:2px,color:#000,font-weight:bold | ||
| style Context fill:#D1E8FF,stroke:#005BBB,stroke-width:2px,color:#000,font-weight:bold | ||
| API[FastAPI Server] | ||
| Analyzer[Content Analyzer] | ||
| CNEngine[Counter-Narrative Engine] | ||
| Context[Context Manager] | ||
|
|
||
| end | ||
|
|
||
| subgraph AI & NLP Layer | ||
| style LLM fill:#E6FFCC,stroke:#66BB66,stroke-width:2px,color:#000,font-weight:bold | ||
| style LangChain fill:#E6FFCC,stroke:#66BB66,stroke-width:2px,color:#000,font-weight:bold | ||
| style Langgraph fill:#E6FFCC,stroke:#66BB66,stroke-width:2px,color:#000,font-weight:bold | ||
| LLM[LLM Service] | ||
| LangChain[LangChain] | ||
| Langgraph[Langgraph] | ||
| end | ||
|
|
||
| subgraph Data Storage | ||
| style VectorDB fill:#FFDDEE,stroke:#CC3366,stroke-width:2px,color:#000,font-weight:bold | ||
| VectorDB[(Vector Database)] | ||
| end | ||
|
|
||
| %% Define Connections with Labels | ||
| style Browser fill:#FFFF99,stroke:#FFAA00,stroke-width:2px,color:#000,font-weight:bold | ||
| Browser -->|User Interaction| UI | ||
| UI -->|Requests| API | ||
| API -->|Process| Analyzer | ||
| Analyzer -->|Analysis| CNEngine | ||
| CNEngine -->|Generates| LLM | ||
| LLM -->|Uses| LangChain | ||
| LLM -->|Uses| Langgraph | ||
| API -->|Manages| Context | ||
| CNEngine -->|Stores| VectorDB | ||
| API -->|Responses| UI | ||
|
|
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
|
|
||
| ## Data Flow & Security | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| %% Define Participants | ||
| participant U as User | ||
| participant F as Frontend | ||
| participant B as Backend | ||
| participant AI as AI Service | ||
| participant D as Data Storage | ||
|
|
||
| %% Interaction Flow | ||
| U->>F: Request/View Content | ||
| F->>B: Forward Request | ||
| B->>AI: Analyze Content & Generate Counter Perspective | ||
| AI->>B: Return Counter Analysis | ||
| B->>F: Deliver Results | ||
| F->>U: Display Balanced Insights | ||
|
|
||
| %% Notes for Clarity | ||
| Note over AI: AI generates counter analysis | ||
| Note over B: Backend processes logic | ||
| Note over F: Frontend updates UI | ||
| ``` | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our | ||
| community a harassment-free experience for everyone, regardless of age, body | ||
| size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
| identity and expression, level of experience, education, socio-economic status, | ||
| nationality, personal appearance, race, religion, or sexual identity | ||
| and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, | ||
| diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment for our | ||
| community include: | ||
|
|
||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, | ||
| and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the | ||
| overall community | ||
|
|
||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery, and sexual attention or | ||
| advances of any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or email | ||
| address, without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Enforcement Responsibilities | ||
|
|
||
| Community leaders are responsible for clarifying and enforcing our standards of | ||
| acceptable behavior and will take appropriate and fair corrective action in | ||
| response to any behavior that they deem inappropriate, threatening, offensive, | ||
| or harmful. | ||
|
|
||
| Community leaders have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions that are | ||
| not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
| decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when | ||
| an individual is officially representing the community in public spaces. | ||
| Examples of representing our community include using an official e-mail address, | ||
| posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| aossie.oss@gmail.com. | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining | ||
| the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed | ||
| unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing | ||
| clarity around the nature of the violation and an explanation of why the | ||
| behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No | ||
| interaction with the people involved, including unsolicited interaction with | ||
| those enforcing the Code of Conduct, for a specified period of time. This | ||
| includes avoiding interactions in community spaces as well as external channels | ||
| like social media. Violating these terms may lead to a temporary or | ||
| permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including | ||
| sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public | ||
| communication with the community for a specified period of time. No public or | ||
| private interaction with the people involved, including unsolicited interaction | ||
| with those enforcing the Code of Conduct, is allowed during this period. | ||
| Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community | ||
| standards, including sustained inappropriate behavior, harassment of an | ||
| individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within | ||
| the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.0, available at | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
|
||
| Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
| enforcement ladder](https://github.com/mozilla/diversity). | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at | ||
| https://www.contributor-covenant.org/faq. Translations are available at | ||
| https://www.contributor-covenant.org/translations. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # 🌟 Contributing to Perspective | ||
|
|
||
| Hi there! Thank you for considering contributing to PictoPy – we’re excited to collaborate with you. Whether you're fixing a bug, improving documentation, or suggesting a new feature — you're welcome here! | ||
|
|
||
| NOTE: Please do not open a PR for the issue which is not yet reviewed and labelled by the maintainer. Wait for the maintainer to give a green light. | ||
|
|
||
|
|
||
| # 🛠 Setting Up the Project | ||
|
|
||
| Follow these steps to run Perspective locally. | ||
|
|
||
| Install: | ||
|
|
||
| - Node.js 18+ | ||
| - Python 3.10+ | ||
| - uv package manager → https://docs.astral.sh/uv/ | ||
| - API keys: | ||
| - OpenAI/Groq | ||
| - Pinecone (or other Vector DB) | ||
| - Google Custom Search | ||
|
|
||
| ## Clone Repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/AOSSIE-Org/Perspective.git | ||
| cd Perspective | ||
| ``` | ||
|
|
||
| ## Frontend (Next.js) | ||
|
|
||
| 1. Install dependencies | ||
| ```bash | ||
| cd frontend | ||
| npm install | ||
| ``` | ||
|
|
||
| 2. Configure environment | ||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 3. Start development server | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Frontend runs at: | ||
| http://localhost:3000 | ||
|
|
||
|
|
||
| ## Backend (FastAPI + uv) | ||
|
|
||
| The backend uses uv for dependency management. | ||
|
|
||
| 1. Install uv: https://docs.astral.sh/uv/ | ||
|
|
||
| 2. Install dependencies: | ||
| ```bash | ||
| cd backend | ||
| uv sync | ||
| ``` | ||
|
|
||
| 3. Configure environment | ||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 4. Fill required keys: | ||
| ```bash | ||
| OPENAI_API_KEY= | ||
| GROQ_API_KEY= | ||
| PINECONE_API_KEY= | ||
| SEARCH_KEY= | ||
| PORT=8000 | ||
| ``` | ||
|
|
||
| 5. Run server | ||
| ```bash | ||
| uv run main.py | ||
| ``` | ||
|
|
||
| Backend runs at: | ||
| http://localhost:8000 | ||
|
|
||
|
|
||
|
|
||
| # 🚀 How to Contribute | ||
|
|
||
| 1. Pick an issue and get it assigned | ||
| 2. Fork the repository | ||
| 3. Create a new branch | ||
| 4. Make your changes and test locally | ||
| 5. Push your branch and open a Pull Request | ||
|
|
||
| Please keep PRs small, focused, and follow the existing code style. | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.