Aonsoku Podcasts

An API designed to provide podcast support for the Aonsoku app.

Report Bug · Request Feature

Table of contents

1. API Documentation
2. Getting Started
   • Prerequisites
   • Installation
   • Running
   • Environment Variables
3. Contributing
4. License

API Documentation

For detailed information on how to use the Aonsoku Podcasts API, please refer to the API Documentation.

(back to top)

Getting Started

Prerequisites

• PHP 8.2 or greater
• Composer
• Laravel

Installation

1. Clone the repo:

git clone https://github.com/victoralvesf/aonsoku-podcasts.git

2. Install dependencies:

composer install

3. Copy the environment file:

cp .env.example .env

4. Edit database config, if you don't want to use sqlite:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=YourDatabaseName
DB_USERNAME=YourUsername
DB_PASSWORD=YourPassword

5. Generate application key:

php artisan key:generate

6. Run database migrations:

php artisan migrate

7. Start the server:

php artisan serve

Tip

If you have node.js installed, you can run:

composer dev

This will run the server, queue, scheduler and logs in parallel.

8. Starting the queue and schedule separated:

# queue
php artisan queue:listen

# schedule
php artisan schedule:work

(back to top)

Running

To deploy the Aonsoku Podcasts API using Docker Compose:

1. Clone the repo:

git clone https://github.com/victoralvesf/aonsoku-podcasts.git

2. Copy the environment file:

cp .env.example .env.production

3. Update the environment file as you need.

Caution

Ensure to fill the database settings. Example:

DB_CONNECTION=mysql
DB_HOST=mysql # needs to be mysql to work with docker compose.
DB_PORT=3306
DB_DATABASE=YourDatabaseName
DB_USERNAME=YourUsername
DB_PASSWORD=YourPassword
DB_ROOT_PASSWORD=YourRootUserPassword

# Make sure to set this to mysql aswell
DB_QUEUE_CONNECTION=mysql

Additionally, generate a key for your .env.production file:

If you don't have access to any Laravel project, you can obtain a random key on this page:

https://laravel-encryption-key-generator.vercel.app/

Thanks to Stefan Zweifel for this helpful tool!

4. Start with Docker Compose

docker compose --env-file .env.production up -d

Environment Variables

• Refer to the .env.example file for a clearer understanding of the settings.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)