CatFM is a simple Python project that creates a music streaming service using Django and Django Channels. It is a Django project that uses the Django REST framework for creating a REST API, and Django Channels for handling WebSocket connections.
The project is divided into three main apps: catuser, radio, and streaming. The catuser app is used for user authentication, the radio app is used for creating radio streams, and the streaming app is used for creating playlists and handling music streaming.
The project is still under development and should not be used in production yet.
The catuser app is responsible for managing user authentication and account management. It provides the necessary infrastructure for user registration, login, and management of user credentials. The app integrates with Django's authentication system and extends it as necessary to meet the specific requirements of the CatFM project. It includes models for storing user data and APIs for handling user-related operations, ensuring secure access to the streaming services.
The radio app facilitates the creation and management of live radio streams. It leverages WebSocket technology to stream audio files continuously over selected channels. The app allows administrators to manage audio files, add or remove them using Django's admin interface, and create multiple broadcast channels. These channels can stream various genres or types of music. The app includes models to represent radio streams and their attributes, as well as services to handle broadcasting logic and WebSocket connections.
The streaming app is designed for on-demand music streaming. It provides users with the capability to request and play different audio files as needed. The app includes functionality for managing audio content, downloading new tracks, and handling requests for new music. Administrators can approve or reject these requests through an API and manage content visibility. The app also supports playlist creation, allowing users to curate playlists based on their preferences. Models within the app store metadata about the audio files and playlists, and APIs enable interaction with the streaming service.
This project is still under development and should not be used in production yet!
However, if you want to try it out, you can clone the repository and follow the instructions in the README.md file to set up a local development environment.
Once you have the environment set up, you can run the app using the command make deploy.
If you want to perform some tests, you can run the command make test.
MIT License
Copyright (c) 2024 Wolfgang Almeida
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
For more information about the project, please visit the GitHub repository: https://github.com/Wolfterro/CatFM