dj_mix_hosting_software/README.md

59 lines
2.0 KiB
Markdown

* [DJ Mix Hosting Software](#dj-mix-hosting-software)
* [About](#about)
* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
# DJ Mix Hosting Software
[![Crowdin](https://badges.crowdin.net/djmixhostingsoftware/localized.svg)](https://crowdin.com/project/djmixhostingsoftware)
## About
DJ Mix Hosting Software is a web application that allows users to upload and share their DJ mixes. The application is
built using PHP and MySQL.
## Features
- User login/registration
- Add, edit, delete DJs
- Add, upload, edit, delete mixes
- View mixes by DJ
- View mixes by genre
- Basic SEO
- S3 file storage _(optional)_
- MP3 tag editing _(optional)_
## Installation
The repo is the source code for the application. You will need to point your web server to this directory.
Create a MySQL database using the .sql files in the `sql` directory.
Copy `includes/config.toml.default` to `includes/config.toml` and update the settings as needed.
## Usage
The application is designed to be used by DJs to upload and share their mixes. Users can listen to mixes by DJ or genre.
Why would you use this over Soundcloud or Mixcloud? You have full control over the mixes and can customize the application to your liking.
## Contributing
Contributions are welcome. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
## License
This is to be determined.
## Contact
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for contact information.
## Acknowledgements
- [Bootstrap](https://getbootstrap.com/)
- [Font Awesome](https://fontawesome.com/)
- [jQuery](https://jquery.com/)
- [PHP](https://www.php.net/)
- [MariaDB](https://mariadb.org/)
- [AWS S3](https://aws.amazon.com/s3/)
- [DigitalOcean](https://www.digitalocean.com/)
- [Crowdin](https://crowdin.com/)
- [Cody Cook](https://codycook.us])