feat: Add GitHub community profile files
- Add CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md - Add issue templates and PR template - Add SUPPORT.md and FUNDING.yml - Improve project visibility and contributor experience
This commit is contained in:
ajaysi
128
.github/SUPPORT.md
vendored
Normal file
128
.github/SUPPORT.md
vendored
Normal file
@@ -0,0 +1,128 @@
|
||||
# Support
|
||||
|
||||
## 🆘 Getting Help
|
||||
|
||||
We're here to help you get the most out of ALwrity! Here are the best ways to get support:
|
||||
|
||||
### 📚 Documentation
|
||||
- **[Main Documentation](https://github.com/AJaySi/ALwrity/wiki)** - Comprehensive guides and tutorials
|
||||
- **[API Documentation](https://github.com/AJaySi/ALwrity/wiki/API-Documentation)** - Complete API reference
|
||||
- **[Setup Guide](https://github.com/AJaySi/ALwrity/wiki/Setup-Guide)** - Installation and configuration
|
||||
- **[User Guide](https://github.com/AJaySi/ALwrity/wiki/User-Guide)** - How to use ALwrity features
|
||||
|
||||
### 💬 Community Support
|
||||
- **[GitHub Discussions](https://github.com/AJaySi/ALwrity/discussions)** - Ask questions and share ideas
|
||||
- **[GitHub Issues](https://github.com/AJaySi/ALwrity/issues)** - Report bugs and request features
|
||||
- **[Discord Community](https://discord.gg/alwrity)** - Real-time chat and support (coming soon)
|
||||
|
||||
### 🐛 Bug Reports
|
||||
If you encounter a bug:
|
||||
1. Check existing [issues](https://github.com/AJaySi/ALwrity/issues) first
|
||||
2. Use our [bug report template](https://github.com/AJaySi/ALwrity/issues/new?template=bug_report.md)
|
||||
3. Include detailed steps to reproduce the issue
|
||||
4. Provide error logs and screenshots when possible
|
||||
|
||||
### ✨ Feature Requests
|
||||
Have an idea for a new feature?
|
||||
1. Check existing [feature requests](https://github.com/AJaySi/ALwrity/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||||
2. Use our [feature request template](https://github.com/AJaySi/ALwrity/issues/new?template=feature_request.md)
|
||||
3. Provide detailed use cases and mockups if possible
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Installation
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/AJaySi/ALwrity.git
|
||||
cd ALwrity
|
||||
|
||||
# Backend setup
|
||||
cd backend
|
||||
pip install -r requirements.txt
|
||||
python start_alwrity_backend.py
|
||||
|
||||
# Frontend setup (in a new terminal)
|
||||
cd frontend
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Backend Won't Start
|
||||
- Check Python version (3.10+ required)
|
||||
- Verify all dependencies are installed: `pip install -r requirements.txt`
|
||||
- Check if port 8000 is available
|
||||
- Review error logs in the terminal
|
||||
|
||||
#### Frontend Build Errors
|
||||
- Check Node.js version (18+ required)
|
||||
- Clear node_modules and reinstall: `rm -rf node_modules && npm install`
|
||||
- Check for TypeScript errors: `npm run type-check`
|
||||
|
||||
#### API Connection Issues
|
||||
- Verify backend is running on http://localhost:8000
|
||||
- Check CORS settings in backend configuration
|
||||
- Ensure API keys are properly configured
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### Performance Issues
|
||||
- Check system resources (CPU, RAM)
|
||||
- Review database query performance
|
||||
- Monitor API rate limits
|
||||
- Clear browser cache and cookies
|
||||
|
||||
### Authentication Problems
|
||||
- Verify API keys are correct
|
||||
- Check token expiration
|
||||
- Clear browser storage
|
||||
- Review authentication logs
|
||||
|
||||
### Content Generation Issues
|
||||
- Verify AI service API keys
|
||||
- Check internet connectivity
|
||||
- Review content generation logs
|
||||
- Ensure sufficient API credits
|
||||
|
||||
## 📞 Contact Information
|
||||
|
||||
### Primary Support
|
||||
- **GitHub Issues**: [Create an issue](https://github.com/AJaySi/ALwrity/issues/new)
|
||||
- **GitHub Discussions**: [Join the discussion](https://github.com/AJaySi/ALwrity/discussions)
|
||||
- **Email**: [support@alwrity.com](mailto:support@alwrity.com)
|
||||
|
||||
### Development Team
|
||||
- **Lead Developer**: [@AJaySi](https://github.com/AJaySi)
|
||||
- **Contributors**: [@uniqueumesh](https://github.com/uniqueumesh), [@DikshaDisciplines](https://github.com/DikshaDisciplines)
|
||||
|
||||
## 🕒 Response Times
|
||||
|
||||
- **Critical Issues**: 24 hours
|
||||
- **Bug Reports**: 2-3 business days
|
||||
- **Feature Requests**: 1 week
|
||||
- **General Questions**: 3-5 business days
|
||||
|
||||
## 📖 Additional Resources
|
||||
|
||||
### Learning Materials
|
||||
- **[Video Tutorials](https://youtube.com/alwrity)** - Step-by-step video guides
|
||||
- **[Blog Posts](https://blog.alwrity.com)** - Tips, tricks, and best practices
|
||||
- **[Case Studies](https://github.com/AJaySi/ALwrity/wiki/Case-Studies)** - Real-world usage examples
|
||||
|
||||
### Community
|
||||
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute to ALwrity
|
||||
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community guidelines
|
||||
- **[Roadmap](https://github.com/AJaySi/ALwrity/wiki/Roadmap)** - Upcoming features and improvements
|
||||
|
||||
## 🎯 Pro Tips
|
||||
|
||||
1. **Join our community** - Get help faster and share your experiences
|
||||
2. **Search before asking** - Many questions have already been answered
|
||||
3. **Provide context** - Include relevant details when asking for help
|
||||
4. **Be patient** - We're a small team working hard to help everyone
|
||||
5. **Contribute back** - Help others by sharing your solutions
|
||||
|
||||
---
|
||||
|
||||
**We're here to help you succeed with ALwrity!** 🚀
|
||||
Reference in New Issue
Block a user