Skip to content

Commit 61cc145

Browse files
Revise README for contributing and documentation clarity
Updated README to improve contributing section and reorganize documentation.
1 parent b4073f4 commit 61cc145

File tree

1 file changed

+12
-170
lines changed

1 file changed

+12
-170
lines changed

README.md

Lines changed: 12 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -1533,182 +1533,24 @@ chore: Update dependencies
15331533
4. **Reference related issues**: "Fixes #123"
15341534
5. **Wait for review**: Maintainers will provide feedback
15351535

1536-
## 📖 Documentation & Resources
1536+
## 🤝 Contributing
15371537

1538-
### Full Documentation
1539-
- **API Swagger Docs**: `https://localhost:44313/swagger`
1540-
- **Syncfusion Pivot Table**: [Documentation](https://www.syncfusion.com/javascript-ui-controls/js-pivot-table)
1541-
- **ASP.NET Core Docs**: [Microsoft Docs](https://docs.microsoft.com/aspnet/core/)
1542-
- **Angular Docs**: [Angular.io](https://angular.io/docs)
1543-
- **React Docs**: [React.dev](https://react.dev)
1538+
Contributions are welcome! Please read our contributing guidelines and submit pull requests to our repository.
15441539

1545-
### API Documentation
1540+
## 📄 License
15461541

1547-
**Base URL**: `https://localhost:44313/Pivot`
1542+
This project is licensed under the **Syncfusion Community License**. See [Syncfusion License](https://www.syncfusion.com/content/downloads/syncfusion_license.pdf) for details.
15481543

1549-
All requests use JSON format with `POST` method.
1544+
## 📚 Resources
15501545

1551-
| Endpoint | Purpose | Auth |
1552-
|----------|---------|------|
1553-
| `/SaveReport` | Create/Update report | Optional |
1554-
| `/LoadReport` | Retrieve report | Optional |
1555-
| `/FetchReport` | List all reports | Optional |
1556-
| `/RemoveReport` | Delete report | Optional |
1557-
| `/RenameReport` | Rename report | Optional |
1546+
- [Syncfusion javascript Documentation](https://ej2.syncfusion.com/javascript/documentation/introduction)
1547+
- [Pivot Table Component Guide](https://ej2.syncfusion.com/javascript/documentation/pivotview/getting-started)
15581548

1559-
### Tutorial Links
1549+
## 🆘 Support
15601550

1561-
1. **Getting Started**: See "Quick Start" section above
1562-
2. **Backend Setup**: Section "Installation & Setup"
1563-
3. **Frontend Integration**: Check your framework in section "Setup Frontend"
1564-
4. **API Integration**: See "Features Deep Dive" section
1565-
1566-
### Blog Posts & Case Studies
1567-
1568-
- Coming soon: Best practices for pivot table design
1569-
- Coming soon: Scaling reports to enterprise systems
1570-
- Coming soon: Security hardening guide
1571-
1572-
### Community Resources
1573-
1574-
- [Syncfusion Community Forums](https://www.syncfusion.com/forums/)
1575-
- [Stack Overflow - Syncfusion Tag](https://stackoverflow.com/questions/tagged/syncfusion)
1576-
- [GitHub Discussions](https://github.com/SyncfusionExamples/)
1577-
1578-
## 🔗 Related Projects & Ecosystem
1579-
1580-
### Similar Projects
1581-
1582-
| Project | Use Case | Comparison |
1583-
|---------|----------|-----------|
1584-
| **Tableau Server** | Enterprise BI | More complex, commercial |
1585-
| **Power BI** | Microsoft Ecosystem | Better with Office 365 |
1586-
| **Grafana** | Monitoring/Dashboards | Time-series focused |
1587-
| **Metabase** | Quick Analytics | Self-contained, limited customization |
1588-
1589-
### Complementary Projects
1590-
1591-
- **Syncfusion GridView**: For tabular data display
1592-
- **Syncfusion Charts**: For data visualization
1593-
- **Syncfusion Dashboard**: Complete BI solution
1594-
- **Entity Framework Core**: ORM alternative to raw SQL
1595-
1596-
### Ecosystem Integrations
1597-
1598-
- **Azure SQL Database**: Replace LocalDB for cloud
1599-
- **Azure App Service**: Host backend in cloud
1600-
- **AWS RDS**: Alternative cloud SQL hosting
1601-
- **Docker Containers**: Containerize backend service
1602-
- **Kubernetes**: Orchestrate multi-instance deployments
1603-
1604-
## ⚖️ License & Legal
1605-
1606-
### License
1607-
1608-
This repository is licensed under the **MIT License** - see [LICENSE](LICENSE) file for details.
1609-
1610-
**MIT License Summary**:
1611-
- ✅ You can use this code for commercial projects
1612-
- ✅ You can modify the code
1613-
- ✅ You can distribute the code
1614-
- ❌ You cannot hold author liable for issues
1615-
- ⚠️ You must include license notice
1616-
1617-
### Copyright Information
1618-
1619-
**Copyright © 2024 Syncfusion, Inc.**
1620-
1621-
All rights reserved. Syncfusion Pivot Table is a registered trademark of Syncfusion, Inc.
1622-
1623-
### Attribution Requirements
1624-
1625-
When using this project, please include:
1626-
1627-
```
1628-
This project uses Syncfusion components.
1629-
Copyright © Syncfusion, Inc. All rights reserved.
1630-
```
1631-
1632-
### License Exceptions
1633-
1634-
- **Syncfusion Libraries**: Subject to Syncfusion's license terms
1635-
- **Open Source Dependencies**: Each maintained under their respective licenses
1636-
- **SQL Server LocalDB**: Free for development (not for production without license)
1637-
1638-
## 💬 Support & Community
1639-
1640-
### Issue Reporting Guidelines
1641-
1642-
When reporting issues, include:
1643-
1644-
1. **Environment Information**
1645-
```
1646-
OS: Windows 10/macOS/Linux
1647-
Browser: Chrome 120
1648-
.NET SDK: 6.0.x
1649-
Node.js: 18.x
1650-
```
1651-
1652-
2. **Steps to Reproduce**
1653-
```
1654-
1. Clone the repository
1655-
2. Run backend with [command]
1656-
3. Open frontend at [url]
1657-
4. Error occurs when [action]
1658-
```
1659-
1660-
3. **Expected vs Actual Behavior**
1661-
- Expected: Report should save
1662-
- Actual: Console shows 404 error
1663-
1664-
4. **Error Messages**
1665-
```
1666-
Full stack trace and console output
1667-
```
1668-
1669-
### Discussion Forums
1670-
1671-
- **GitHub Issues**: Bug reports and feature requests
1672-
- **GitHub Discussions**: General questions and ideas
1673-
- **Syncfusion Forums**: Pivot table component questions
1674-
1675-
### Chat Channels
1676-
1677-
- **Discord**: [Join Community](https://discord.gg/syncfusion)
1678-
- **Slack**: [@Syncfusion on Twitter](https://twitter.com/Syncfusion)
1679-
1680-
### Commercial Support Options
1681-
1682-
- **Syncfusion Support**: [Premium Support Plan](https://www.syncfusion.com/support/)
1683-
- **Paid Consulting**: Available upon request
1684-
- **Custom Development**: Syncfusion can develop custom features
1685-
1686-
### Response Time Expectations
1687-
1688-
- **Community Issues**: 3-5 business days
1689-
- **Premium Support**: 24 hours
1690-
- **Critical Bugs**: Next business day
1691-
1692-
---
1693-
1694-
## 🎓 Learning Path
1695-
1696-
### Beginner
1697-
1. Clone and run the project locally
1698-
2. Understand database schema
1699-
3. Make your first API call
1700-
4. Create a basic report
1701-
1702-
### Intermediate
1703-
1. Customize frontend UI
1704-
2. Add authentication to API
1705-
3. Implement validation
1706-
4. Deploy to cloud
1707-
1708-
### Advanced
1709-
1. Implement caching strategies
1710-
2. Add report versioning
1711-
3. Scale to multiple servers
1712-
4. Implement audit logging
1551+
For issues, questions, or suggestions:
1552+
- 📧 Open an issue on GitHub
1553+
- 💬 Check existing documentation
1554+
- 🌐 Visit Syncfusion support forums
17131555

17141556
---

0 commit comments

Comments
 (0)