https://github.com/yadgah/yadgah
Yadgah A Platform for Experience Sharing & Q&A
https://github.com/yadgah/yadgah
django good-first-issue hacktoberfest persian python questions share website
Last synced: about 1 year ago
JSON representation
Yadgah A Platform for Experience Sharing & Q&A
- Host: GitHub
- URL: https://github.com/yadgah/yadgah
- Owner: Yadgah
- License: mit
- Created: 2025-01-07T16:14:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-30T19:53:28.000Z (over 1 year ago)
- Last Synced: 2025-03-30T20:28:56.581Z (over 1 year ago)
- Topics: django, good-first-issue, hacktoberfest, persian, python, questions, share, website
- Language: HTML
- Homepage: https://yadgahh.ir
- Size: 18.1 MB
- Stars: 10
- Watchers: 1
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Yadgah
**A Platform for Experience Sharing & Q&A**
Yadgah is a community-driven platform designed for sharing experiences, asking questions, and engaging in discussions. Inspired by Quera and Stack Overflow, Yadgah fosters a collaborative environment where users can learn, contribute, and grow.
---
## ✨ Features
- **User Profiles:** Create and customize your profile to share insights and engage with the community.
- **Q&A System:** Ask questions and receive answers from knowledgeable users.
- **Interactive Engagement:** Like, comment on, and rate answers to enhance discussions.
- **Organized Content:** Browse topics in various categories:
- Work & Career
- Education
- Technology
- Health
- And more!
- **User Ranking System:** Gain recognition based on contributions and community feedback.
---
## 🚀 Installation
### Prerequisites
- Python 3.x
- pip (Python package manager)
### Setup Instructions
1. **Clone the repository:**
```bash
git clone https://github.com/Yadgah/Yadgah.git
cd Yadgah
```
2. **Install dependencies:**
```bash
pip install -r requirements.txt
```
3. **Apply database migrations:**
```bash
python manage.py migrate
```
4. **Create a superuser (admin account):**
```bash
python manage.py createsuperuser
```
5. **Start the development server:**
```bash
python manage.py runserver
```
---
## 🛠 Development
Yadgah follows best coding practices to ensure maintainability and quality.
- **Code Linting:** `flake8` for Python.
- **Pre-commit Hooks:** Automates code checks before commits.
### GitHub Actions Workflows
Automated workflows include:
- **Django CI:** Ensures smooth integration.
- **Code Linting:** Maintains style and quality.
- **Pre-commit Checks:** Verifies code before merging.
- **Security Scans:** Detects vulnerabilities early.
---
## 📂 Project Structure
```
.
├── blog
│ ├── admin.py
│ ├── apps.py
│ ├── forms.py
│ ├── __init__.py
│ ├── models.py
│ ├── signals.py
│ ├── templates
│ │ ├── base.html
│ │ └── blog
│ │ ├── post_create.html
│ │ ├── post_detail.html
│ │ ├── post_edit.html
│ │ └── post_list.html
│ ├── tests.py
│ ├── urls.py
│ └── views.py
├── CHANGELOG.md
├── db.sqlite3
├── favicon.ico
├── home
│ ├── admin.py
│ ├── apps.py
│ ├── forms.py
│ ├── __init__.py
│ ├── models.py
│ ├── signals.py
│ ├── sitemaps.py
│ ├── static
│ │ ├── default-avatar.png
│ │ ├── favicon.ico
│ │ ├── icons
│ │ │ ├── menu-svgrepo-com.svg
│ │ │ ├── reaction
│ │ │ │ ├── dislike-svgrepo-com.svg
│ │ │ │ └── like-1-svgrepo-com.svg
│ │ │ └── search-svgrepo-com.svg
│ │ ├── images
│ │ │ └── default-post-image.jpg
│ │ └── thumbnail.png
│ ├── templates
│ │ ├── 404.html
│ │ ├── 500.html
│ │ ├── ask_question.html
│ │ ├── base.html
│ │ ├── edit_question.html
│ │ ├── edit_reply.html
│ │ ├── explore.html
│ │ ├── index.html
│ │ ├── leaderboard.html
│ │ ├── login.html
│ │ ├── privacy_policy.html
│ │ ├── profile.html
│ │ ├── question_detail.html
│ │ ├── rules.html
│ │ ├── search_results.html
│ │ ├── signup.html
│ │ └── user_profile.html
│ ├── templatetags
│ │ ├── custom_filters.py
│ │ └── __init__.py
│ ├── tests.py
│ ├── urls.py
│ └── views.py
├── LICENSE
├── manage.py
├── pyproject.toml
├── README.md
├── requirements.txt
└── Yadgah
├── asgi.py
├── __init__.py
├── settings.py
├── urls.py
└── wsgi.py
```
---
## 📜 License
Yadgah is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
---
## 💬 Contributing
We welcome contributions! To contribute:
1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Submit a pull request with a clear description of changes.
---
## 🌐 Connect with Us
Have questions or feedback? Reach out via [GitHub Issues](https://github.com/Yadgah/Yadgah/issues) or join our discussions.