d2bd6dd342
Message embeds Closes #17 See merge request litecord/litecord!10 |
||
|---|---|---|
| images | ||
| litecord | ||
| manage | ||
| static | ||
| tests | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| LICENSE | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.md | ||
| __init__.py | ||
| config.ci.py | ||
| config.example.py | ||
| discord_endpoints.txt | ||
| manage.py | ||
| nginx.conf | ||
| requirements.txt | ||
| run.py | ||
| schema.sql | ||
| setup.py | ||
| tox.ini | ||
README.md
Litecord is an open source, clean-room design reimplementation of Discord's HTTP API and Gateway in Python 3.
This project is a rewrite of litecord-reference.
Project Goals
- Being able to unit test bots in an autonomous fashion.
- Doing research and exploration on the Discord API.
Non-goals
- Being used as a "self-hostable Discord alternative".
Caveats
- Unit testing is incomplete.
- Currently, there are no plans to support voice chat.
- You must figure out how to connect to a Litecord instance. Litecord will not distribute official client code from Discord nor provide ways to modify the official client.
Installation
Requirements:
- Python 3.7+
- PostgreSQL (tested using 9.6+)
- gifsicle for GIF emoji and avatar handling
- pipenv
Download the code
$ git clone https://gitlab.com/litecord/litecord.git && cd litecord
Setting up the database
It's recommended to create a separate user for the litecord database.
# Create the PostgreSQL database.
$ createdb litecord
# Apply the base schema to the database.
$ psql -f schema.sql litecord
Then, you should run database migrations:
$ pipenv run ./manage.py migrate
Configuring
Copy the config.example.py file and edit it to configure your instance:
$ cp config.example.py config.py
$ $EDITOR config.py
Install packages
$ pipenv install --dev
Running
Hypercorn is used to run Litecord. By default, it will bind to 0.0.0.0:5000.
This will expose your Litecord instance to the world. You can use the -b
option to change it (e.g. -b 0.0.0.0:45000).
$ pipenv run hypercorn run:app
You can use --access-log - to output access logs to stdout.
It is recommended to run litecord behind NGINX. You can use the
nginx.conf file at the root of the repository as a template.
Does it work?
You can check if your instance is running by performing an HTTP GET request on
the /api/v6/gateway endpoint. For basic websocket testing, a tool such as
ws can be used.
Updating
Update the code and run any new database migrations:
$ git pull
$ pipenv run ./manage.py migrate
Running tests
Running tests involves creating dummy users with known passwords. Because of this, you should never setup a testing environment in production.
# Setup any testing users:
$ pipenv run ./manage.py setup_tests
# Install tox:
$ pip install tox
# Run lints and tests:
$ tox