Put cmds in codeblocks

Jeremy "EndenDragon" Zhang 2018-09-15 13:59:21 -07:00
parent 949d05ec19
commit 018fdd8089

@ -10,11 +10,11 @@ Once you cloned the project, install the Python dependencies with ``pip install
Okay, not really, but you will have to set-up one in order to host Titan. 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. Okay, not really, but you will have to set-up one in order to host Titan. 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.
1. Install alembic with Python 3.5's pip pip install alembic 1. Install alembic with Python 3.5'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 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.
5. Check your database tables to see if they are created. If so, you have finished migrating your database! Remember to run Step 4 every now and then just in case if there are database updates. (Presumably on every git pull). 5. Check your database tables to see if they are created. If so, you have finished migrating your database! Remember to run Step 4 every now and then just in case if there are database updates. (Presumably on every `git pull`).
Titan also requires a Redis instance in order to function. There is no specific prerequisites before utilizing Titan with Redis. Follow the [official Redis installation instructions to install](https://redis.io/topics/quickstart) and start using Redis. Titan also requires a Redis instance in order to function. There is no specific prerequisites before utilizing Titan with Redis. Follow the [official Redis installation instructions to install](https://redis.io/topics/quickstart) and start using Redis.