mirror of
https://github.com/RafaelSolVargas/Vulkan.git
synced 2025-10-29 16:57:23 +00:00
Updating README.md and creating HEROKU.md
This commit is contained in:
parent
4fd23c56b6
commit
6ba7734a36
23
HEROKU.md
Normal file
23
HEROKU.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<h1 align="center">Configuring Heroku</h1>
|
||||||
|
|
||||||
|
Nobody wants to run the Vulkan process on their machine, so we host the process on Heroku, a cloud platform that contains free accounts.<br>
|
||||||
|
To configure the Vulkan to run in your Heroku account you will need to:
|
||||||
|
|
||||||
|
- Create an application project in Heroku.
|
||||||
|
- Configure the environment variables in your application.
|
||||||
|
- Add these buildpacks to your application:
|
||||||
|
|
||||||
|
```
|
||||||
|
- heroku/python
|
||||||
|
- https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git
|
||||||
|
- https://github.com/xrisk/heroku-opus.git
|
||||||
|
```
|
||||||
|
The order shown above is exactly the upside-down order that Buildpacks should appear in Heroku.
|
||||||
|
- Set the heroku stack to be `heroku-20`. <br>
|
||||||
|
As shown in this issue: [Issue](https://github.com/RafaelSolVargas/Vulkan/issues/25) the heroku-buildpack doesn't work properly with the heroku application Stack set as above `heroku-20`.
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
This [Youtube Video](https://www.youtube.com/watch?v=BPvg9bndP1U&ab_channel=TechWithTim) shows the process of hosting a Bot in Heroku.
|
||||||
|
|
||||||
|
You can also fork this project and set in Heroku to your application automatically deploy when your project receive a new commit, and then control when new versions of Vulkan become available to your Bot.
|
||||||
18
README.md
18
README.md
@ -1,4 +1,4 @@
|
|||||||
<h1 align="center"> Vulkan</h1>
|
<h1 align="center">Vulkan</h1>
|
||||||
|
|
||||||
|
|
||||||
A Music Discord Bot, that plays *Youtube*, *Spotify*, *Deezer* links or raw queries. Vulkan is open source, so everyone can fork this project, follow the instructions and use it in their own way, executing it in your own machine or hosting in others machines to work 24/7.
|
A Music Discord Bot, that plays *Youtube*, *Spotify*, *Deezer* links or raw queries. Vulkan is open source, so everyone can fork this project, follow the instructions and use it in their own way, executing it in your own machine or hosting in others machines to work 24/7.
|
||||||
@ -67,14 +67,12 @@ The config file is located at ```./config/Configs.py```, it doesn't require any
|
|||||||
- Run ```python main.py``` in console to start
|
- Run ```python main.py``` in console to start
|
||||||
|
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<hr>
|
||||||
|
<br>
|
||||||
|
|
||||||
## **🚀 Heroku**
|
## **🚀 Heroku**
|
||||||
To deploy and run your Bot in Heroku 24/7, you will need the Procfile located in root, then follow the instructions in this [video](https://www.youtube.com/watch?v=BPvg9bndP1U&ab_channel=TechWithTim). In addition, also add these two buildpacks to your Heroku Application:
|
To deploy and run your Bot in Heroku 24/7, follow the instructions in the [Heroku Instructions](HEROKU.md) page.
|
||||||
|
|
||||||
- https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git
|
|
||||||
|
|
||||||
- https://github.com/xrisk/heroku-opus.git
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 🧪 Tests
|
## 🧪 Tests
|
||||||
The tests were written manually with no package due to problems with async function in other packages, to execute them type in root: <br>
|
The tests were written manually with no package due to problems with async function in other packages, to execute them type in root: <br>
|
||||||
@ -82,9 +80,9 @@ The tests were written manually with no package due to problems with async funct
|
|||||||
|
|
||||||
|
|
||||||
## 📖 License
|
## 📖 License
|
||||||
- This program is free software: you can redistribute it and/or modify it under the terms of the [MIT License](https://github.com/RafaelSolVargas/Vulkan/blob/master/LICENSE).
|
This program is free software: you can redistribute it and/or modify it under the terms of the [MIT License](https://github.com/RafaelSolVargas/Vulkan/blob/master/LICENSE).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 🏗️ Contributing
|
## 🏗️ Contributing
|
||||||
- If you are interested in upgrading this project i will be very happy to receive a PR or Issue from you. See TODO project to see if i'm working in some feature now.
|
If you are interested in upgrading this project i will be very happy to receive a PR or Issue from you. See TODO project to see if i'm working in some feature now.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user