Yadciel/Titan
1
0
Fork 0
mirror of https://github.com/TitanEmbeds/Titan.git synced 2024-11-14 01:51:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minimum python 3.6

Browse Source
This commit is contained in:
Jeremy Zhang 2019-03-17 09:38:19 +00:00
parent e8af58206c
commit 6c48efb6c6
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -14,9 +14,9 @@ There was a time when Discord doesn't support embedding the chat on a webpage. B
## Installation ## Installation
Would you like to run your own copy of Titan Embeds? There are two parts that integrate nicely together. The webapp (website) handles the frontend and communication with the database to retrieve server messages, etc. The discordbot (bot) handles the communcation Would you like to run your own copy of Titan Embeds? There are two parts that integrate nicely together. The webapp (website) handles the frontend and communication with the database to retrieve server messages, etc. The discordbot (bot) handles the communcation
between Discord's websockets and pushing out the data to the database for the webapp. Check out the respective folder for their installation instructions. Titan is written in Python and requires **Python 3.5.5** at minimum to run. between Discord's websockets and pushing out the data to the database for the webapp. Check out the respective folder for their installation instructions. Titan is written in Python and requires **Python 3.6.8** at minimum to run.
Once you cloned the project, install the Python depends with `pip install -r requirements.txt`. Ensure that you are utilizing Python 3.5's pip. Once you cloned the project, install the Python depends with `pip install -r requirements.txt`. Ensure that you are utilizing Python 3.6's pip.
If you happen to have a copy of Ubuntu on your server, you may head onto our [Ansible Playbooks](https://github.com/TitanEmbeds/ansible-playbooks) repository and perform a **near-to-automatic** installation of TitanEmbeds. If you happen to have a copy of Ubuntu on your server, you may head onto our [Ansible Playbooks](https://github.com/TitanEmbeds/ansible-playbooks) repository and perform a **near-to-automatic** installation of TitanEmbeds.
@ -24,7 +24,7 @@ If you happen to have a copy of Ubuntu on your server, you may head onto our [An
### Database ### Database
To set up the database for it to work with the webapp and the discordbot, one must use **alembic** to *migrate* their databases to the current database state. To do so, please follow these instructions. To set up the database for it to work with the webapp and the discordbot, one must use **alembic** to *migrate* their databases to the current database state. To do so, please follow these instructions.
**PostgreSQL supports proper indexing and suitable for Titan needs. For this reason, Titan only supports using a PostgreSQL database.** **PostgreSQL supports proper indexing and suitable for Titan needs. For this reason, Titan only supports using a PostgreSQL database.**
1. Install alembic with **Python 3.5's pip** `pip install alembic` 1. Install alembic with **Python 3.6's pip** `pip install alembic`
2. Change your directory to the webapp where the alembic files are located `cd webapp` 2. Change your directory to the webapp where the alembic files are located `cd webapp`
3. Clone `alembic.example.ini` into your own `alembic.ini` file to find and edit the following line `sqlalchemy.url` to equal your database uri. [See here](http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls) if you need help understanding how database uri works in SQLalchemy. 3. Clone `alembic.example.ini` into your own `alembic.ini` file to find and edit the following line `sqlalchemy.url` to equal your database uri. [See here](http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls) if you need help understanding how database uri works in SQLalchemy.
4. In your terminal, run `alembic upgrade head` to upgrade your database tables to the current version on git. As long as there are only *INFO* messages and no errors, you should be fine. 4. In your terminal, run `alembic upgrade head` to upgrade your database tables to the current version on git. As long as there are only *INFO* messages and no errors, you should be fine.

2
discordbot/README.md
View File

@ -3,6 +3,6 @@ The DiscordBot portion handles the communcation with Discord's websockets to pro
It also includes misc. features to moderate guest users, etc. right in your discord server! It also includes misc. features to moderate guest users, etc. right in your discord server!
# Installation # Installation
1. Clone the repo (make sure you have **Python 3.5** (or above) installed on your system.) 1. Clone the repo (make sure you have **Python 3.6.8** (or above) installed on your system.)
2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards 2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
3. Start the bot using `python run.py` 3. Start the bot using `python run.py`

2
webapp/README.md
View File

@ -2,6 +2,6 @@
The webapp portion handles the frontend (it's what the users see). The webapp highly depends on the discordbot to push websockets data to the database. The webapp portion handles the frontend (it's what the users see). The webapp highly depends on the discordbot to push websockets data to the database.
# Installation # Installation
1. Clone the repo (make sure you have **Python 3.5.5** (or above) installed on your system.) 1. Clone the repo (make sure you have **Python 3.6.8** (or above) installed on your system.)
2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards 2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
3. Run the development web via `python run.py` -- Though we suggest to use a better server software (look into gunicorn, nginx, uwsgi, etc) 3. Run the development web via `python run.py` -- Though we suggest to use a better server software (look into gunicorn, nginx, uwsgi, etc)