An open API service indexing awesome lists of open source software.

https://github.com/smileychris/worshipwise


https://github.com/smileychris/worshipwise

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# WorshipWise

A modern worship song tracking and service management system built for worship teams. WorshipWise helps prevent song repetition, streamlines service planning, and provides valuable insights into your church's worship patterns.

**🎯 Current Status**: Sprint 5 Complete (42% - 5/12 sprints)
**🚧 In Progress**: Sprint 6 - Advanced Service Features & Analytics

## ✨ Features

### ✅ **Completed Features**

- **Complete Authentication System** with role-based access (musicians, leaders, admins)
- **Comprehensive Song Management** with CRUD operations, search, and filtering
- **File Upload System** for chord charts, sheet music, and audio files
- **Real-Time Collaboration** with WebSocket subscriptions
- **Song Usage Tracking** to prevent repetition with visual indicators
- **Basic Service Management** for worship planning
- **Responsive Design** that works on all devices
- **Modern UI Component Library** built with Tailwind CSS

### 🚧 **In Development**

- **Advanced Service Builder** with drag-and-drop functionality
- **Analytics Dashboard** with usage patterns and insights
- **Team Collaboration Tools** for worship planning

### 🎯 **Planned Features**

- Mobile PWA with offline support
- Smart song recommendations based on usage patterns
- Advanced reporting and analytics
- Integration with popular worship software
- Multi-church management features

## 🚀 Getting Started

### For End Users

WorshipWise is currently in development. Once released, it will be available as:

- **Web Application**: Access from any browser
- **Desktop App**: Native applications for Windows, macOS, and Linux
- **Mobile App**: Progressive Web App (PWA) for mobile devices

### For Developers

Want to contribute or run locally? See our [Development Guide](README_DEVELOPMENT.md) for:

- Setup instructions
- Development workflow
- Architecture overview
- Contribution guidelines

## 🎵 How It Works

### For Worship Leaders

1. **Song Management**: Add your church's song catalog with keys, tempo, and attachments
2. **Service Planning**: Create services with drag-and-drop ease
3. **Usage Tracking**: See when songs were last used to avoid repetition
4. **Team Collaboration**: Work together with your worship team in real-time

### For Musicians

1. **Access Songs**: View the song library with chord charts and sheet music
2. **Practice Materials**: Download or view practice materials for upcoming services
3. **Service Preparation**: See your assigned songs and any special notes
4. **Key Changes**: View transposed keys for your instrument

### For Church Administrators

1. **User Management**: Manage worship team member access and roles
2. **Analytics**: View usage patterns and service statistics
3. **Reporting**: Generate reports on song usage and team activity
4. **Data Management**: Backup and manage your church's song data

## 📈 Development Progress

### ✅ **Completed Phases**

- **Phase 1**: Foundation & Authentication ✅
- **Phase 2**: Song Management & File Uploads ✅
- **Phase 3**: Analytics Dashboard & Database Schema Consolidation ✅

### 🚧 **Current Development**

- **Phase 4**: Intelligent Worship Insights & Recommendations (In Progress)

### 🎯 **Upcoming Features**

- **Phase 5**: Enhanced Service Features & Real-Time Collaboration
- **Phase 6**: Mobile App & Offline Support
- **Phase 7**: Integrations & Polish

_Detailed development roadmap available for contributors in [DEVELOPMENT_ROADMAP.md](plan/DEVELOPMENT_ROADMAP.md)_

## 🤝 Contributing

We welcome contributions from developers who want to help improve WorshipWise!

### How to Contribute

1. Check the [development roadmap](plan/DEVELOPMENT_ROADMAP.md) for current priorities
2. Read our [Development Guide](README_DEVELOPMENT.md) for setup instructions
3. Create a feature branch and follow our coding standards
4. Submit a pull request with a clear description

### Areas Where We Need Help

- **Frontend Development**: Svelte/SvelteKit components and UI/UX
- **Backend Features**: PocketBase integrations and data modeling
- **Testing**: Unit tests, E2E tests, and quality assurance
- **Documentation**: User guides, API documentation, and tutorials
- **Design**: UI/UX improvements and accessibility enhancements

## 🔒 Privacy & Security

WorshipWise is designed with security in mind:

- **Role-based Access**: Different permission levels for team members
- **Data Protection**: Secure file storage and data handling
- **Local Control**: Self-hosted option keeps your data in your control
- **Regular Updates**: Security patches and improvements

## 📚 Documentation

### For Users

- **User Guide**: Coming soon with the first release
- **Feature Overview**: This README file
- **Support**: Contact information below

### For Developers

- **Development Setup**: [README_DEVELOPMENT.md](README_DEVELOPMENT.md)
- **Project Roadmap**: [plan/DEVELOPMENT_ROADMAP.md](plan/DEVELOPMENT_ROADMAP.md)
- **Database Schema**: [plan/DATABASE_SCHEMA.md](plan/DATABASE_SCHEMA.md)
- **Technical Guides**: Available in the `plan/` directory

## 🆘 Support

### For Users

Once released, support will be available through:

- User documentation and tutorials
- Community forums and discussions
- Direct support channels

### For Developers

For development questions or contributions:

1. Check the [Development Guide](README_DEVELOPMENT.md)
2. Review existing issues and discussions
3. Create a new issue with detailed information

## 📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

**Built with ❤️ for worship teams everywhere**