https://github.com/bladelist/bladelist

An opesource Discord Bot and Server Listing site build with Django.
https://github.com/bladelist/bladelist

discord django django-rest-framework python tortoise-community

Last synced: about 1 month ago
JSON representation

An opesource Discord Bot and Server Listing site build with Django.

• Host: GitHub
• URL: https://github.com/bladelist/bladelist
• Owner: Bladelist
• License: mit
• Created: 2021-05-26T13:11:18.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-20T05:53:04.000Z (over 2 years ago)
• Last Synced: 2024-05-12T00:47:24.146Z (8 months ago)
• Topics: discord, django, django-rest-framework, python, tortoise-community
• Language: HTML
• Homepage: https://bladelist.gg
• Size: 2.02 MB
• Stars: 8
• Watchers: 0
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Welcome to Bladelist 👋



  

  

    

  

  

    

  

  

    

  

  

    

  



> BladeList was built for users and developers to manage with ease thier bot page and create something clean.

## Setup instruction

#### You would need a linux system for development. Windows raises python-decouple errors. More info [here](https://github.com/bladelist/bladelist/issues/1).

#### You need Python 3.8 or above installed on your system.

### Development Setup

```bash

# Clone the repository or download as zip and cd into the root folder (bladelist)

# Terminal instructions (You're supposed run the below commands during the initial setup)

# Remove existing virtualenv module, We will let poetry install the required version

$ sudo apt-get remove virtualenv -y && sudo python3 -m pip uninstall virtualenv -y

# Install poetry

$ pip install poetry

# Install dependencies from poetry

$ poetry install

$ sudo nano .env

# add the following environment variables

SECRET_KEY = "your_secret_key" #example: test

DB_NAME = "your_db_name"

DB_HOST = "your_db_host"

DB_PASS = "your_db_password"

DB_USER = "your_db_user"

DEBUG = True

ENCRYPTION_SALT = "your_encryption_salt"

ENCRYPTION_ITERATION = your_iteration_count # example:  10

AUTH_HANDLER_URL="http://localhost:8000/login/"

AUTH_CALLBACK_URL="http://localhost:8000login/handlers/"

OAUTH_CLIENT_ID = "your_client_id"

OAUTH_CLIENT_SECRET = "your_client_secret"

DISCORD_API_TOKEN="your_discord_api_token"

LOG_CHANNEL_ID="your_log_channel_id_here"

# Run the development server locally

$ poetry run python3 manage.py runserver 

# this should run the Django development server on your localhost:8000.

# now you can visit http://127.0.0.1:8000 and access the site.

```

### Other requirements for development:

1. You need to setup a local postgres database and set values related to it the .env file.

2. Quick setup guide for Ubuntu: [POSTGRES LOCAL SETUP](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04/)

###  How to make changes?  

```bash

# All changes will first go to development branch and will be merged into master after code review.

# Go to your project directory and checkout to development branch

$ git checkout development

$ git checkout -b "name_of_branch" # example: git checkout -b other/restruture 

# After this you can start making the changes in your branch and push changes to the

# dev branch by making a pr to the development branch fro your branch.

# NOTE:

1. Add the prefix 'feature' to your branch name if it adds a feature, eg,: feature/add_bot

2. Add the prefix 'bug' to your branch name if it fixes a bug, eg,: bug/fix_bot

3. Add the prefix 'other' to your branch name if its none of the above two, eg,: other/code_clean_up

```

### Adding host file configuration for subdomain access in development

### Production Setup

#### Addition Requirements:

[NGINX](https://nginx.org/en/): Webserver for handling requests and serving django assets.

[Supervisor](http://supervisord.org/): Process management tool for keeping Django running. It also provides logging in events of unaccounted crashes and restarts the application to keep it online.

#### Setup procedure for Ubuntu 20.04 LTS. This will also work for all Debian/Ubuntu based distros. Procedures for other distros maybe slightly different but follows almost the same flow.

```bash

# Clone the repository or download as zip and cd into the root folder (bladelist)

# Update and upgrade apt

$ sudo apt update && sudo apt upgrade -y

# If pip is not installed

$ sudo apt-get install python3-pip -y

# Remove virtualenv and let poetry install the required version

$ sudo apt-get remove virtualenv -y && sudo python3 -m pip uninstall virtualenv -y

# Clone the repository and cd into the folder

$ git clone https://github.com/bladelist/bladelist.git && cd bladelist

# Install poetry

$ sudo python3 -m pip install poetry

# Install dependencies from poetry

$ sudo poetry install

$ sudo nano .env

# add the following environment variables

SECRET_KEY = "your_secret_key"

DB_NAME = "your_db_name"

DB_HOST = "your_db_host"

DB_PASS = "your_db_password"

DB_USER = "your_db_user"

DEBUG = False

ENCRYPTION_SALT = "your_encryption_salt"

ENCRYPTION_ITERATION = your_iteration_count

AUTH_HANDLER_URL="https://bladelist.gg/login/"

AUTH_CALLBACK_URL="https://bladelist.gg/login/handlers/"

OAUTH_CLIENT_ID = "your_client_id"

OAUTH_CLIENT_SECRET = "your_client_secret"

DISCORD_API_TOKEN="your_discord_api_token"

LOG_CHANNEL_ID="your_log_channel_id_here"

# Run collectstatic to collect static files to assets folder for production

$ sudo poetry run python3 manage.py collectstatic

# install supervisord

$ sudo apt install supervisor -y

# install nginx

$ sudo apt install nginx -y

```

At this point, nginx should be running. 

If inbound connections are enabled for port 80, you'll be able to visit the ip with a browser which should give you the default NGINX landing page.

#### Supervisord configurations

add the below config inside `/etc/supervisor/conf.d/gunicorn.conf`

```shell

[program:gunicorn]

directory=/home/ubuntu/bladelist

command=poetry run python3 -m gunicorn --workers 3 --bind unix:/home/ubuntu/bladelist/app.sock core.wsgi:application

autostart=true

autorestart=true

stderr_logfile=/var/log/gunicorn/gunicorn.err.log

stdout_logfile=/var/log/gunicorn/gunicorn.out.log

[group:guni]

programs:gunicorn

```

Make log and output files for supervisor

```bash

$ sudo mkdir /var/log/gunicorn && cd /var/log/gunicorn

$ sudo touch gunicorn.out.log

$ sudo touch gunicorn.err.log

```

Update supervisor to propagate changes

```bash

# Reread supervisor configurations

$ sudo supervisorctl reread

# Update supervisor configurations

$ sudo supervisorctl update

# Check if supervisor is correctly configured. 

$ sudo supervisorctl status

# If correctly configured the application should be running with pid and shows uptime. 

# Otherwise check the configurations or logs and try again.

# In case if supervisor status shows restarting, 

# 1) Check if gunicorn is installed 

# 2) check if the log and output files exist for supervisor

# 3) check the logs and check the Django application

# In case if supervisor status shows exited quickly

# 1) check if the directory and commands in the gunicorn.conf is correct

# 2) check the application, the environment variables, database.

```

#### NGINX Configurations

add the below config inside `/etc/nginx/sites-available/django.conf`

```shell

server {

        listen 80;

#        listen 443 ssl http2;

#        listen [::]:443 ssl http2;

#        ssl on;

#        ssl_certificate         /etc/ssl/certs/cert.pem;

#        ssl_certificate_key     /etc/ssl/private/key.pem;

#        ssl_client_certificate /etc/ssl/certs/cloudflare.crt;

#        ssl_verify_client on;

        server_name ;

        location / {

                include proxy_params;

                proxy_pass http://unix:/home/ubuntu/bladelist/app.sock;

        }

        location /static/ {

                autoindex on;

                alias /home/ubuntu/bladelist/assets/;

        }   

        location /protected/media/ {

                internal;

                alias /home/ubuntu/bladelist/media/;

        }

    

}

```

Once added, test if the configurations are okay and symlink with `sites-enabled`

```bash

$ sudo nginx -t

# If configurations are not okay, Check the nginx configuration again to see if paths added are correct

# If configurations shows okay, Symlink with sites-enabled

$ sudo ln  /etc/nginx/sites-available/django.conf /etc/nginx/sites-enabled

# Test nginx again

$ sudo nginx -t

# If configuration shows okay, Reload nginx

$ sudo systemctl reload nginx

# Reload supervisor

$ sudo systemctl reload supervisor

```

#### Once all the above setups are complete, we'll be able to visit the site in the domain/ip provided in the nginx configuration.