mirror of https://gitlab.com/litecord/litecord.git
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
# Project structure + Project-specific questions
|
|
|
|
## `attachments` and `images`
|
|
|
|
They're empty folders on purpose. Litecord will write files to them to hold
|
|
message attachments or avatars.
|
|
|
|
## `manage`
|
|
|
|
Contains the `manage.py` script's main function, plus all the commands.
|
|
A point of interest is the `manage/cmd/migration/scripts` folder, as they hold
|
|
all the SQL scripts required for migrations.
|
|
|
|
## `litecord`
|
|
|
|
The folder + `run.py` contain all of the backend's source code. The backend runs
|
|
Quart as its HTTP server, and a `websockets` server for the Gateway.
|
|
|
|
- `litecord/blueprints` for everything HTTP related.
|
|
- `litecord/gateway` for main things related to the websocket or the Gateway.
|
|
- `litecord/embed` contains code related to embed sanitization, schemas, and
|
|
mediaproxy contact.
|
|
- `litecord/ratelimits` hold the ratelimit implementation copied from
|
|
discord.py plus a simple manager to hold the ratelimit objects. a point of
|
|
interest is `litecord/ratelimits/handler.py` that holds the main thing.
|
|
- `litecord/pubsub` is defined on `docs/pubsub.md`.
|
|
- `litecord/voice` holds the voice implementation, LVSP client, etc.
|
|
|
|
There are other files around `litecord/`, e.g the snowflake library, presence/
|
|
image/job managers, etc.
|
|
|
|
## `static`
|
|
|
|
Holds static files, such as a basic index page and the `invite_register.html`
|
|
page.
|
|
|
|
## `tests`
|
|
|
|
Tests are run with `pytest` and the asyncio plugin for proper testing. A point
|
|
of interest is `tests/conftest.py` as it contains test-specific configuration
|
|
for the app object. Adding a test is trivial, as pytest will match against any
|
|
file containing `test_` as a prefix.
|
|
|
|
## Litecord-specifics
|
|
|
|
### How do I fetch a User/Guild/Channel/DM/Group DM/...?
|
|
|
|
You can find the common code to fetch those in `litecord/storage.py` on the
|
|
`Storage` class, acessible via `app.storage`. A good example is
|
|
`Storage.get_user`. There are no custom classes to hold common things used in
|
|
the Discord API.
|
|
|
|
They're all dictionaries and follow *at least* the same fields you would expect
|
|
on the Discord API.
|
|
|
|
### How are API errors handled?
|
|
|
|
Quart provides custom handling of errors via `errorhandler()`. You can look
|
|
at the declared error handlers on `run.py`. The `500` error handler
|
|
converts any 500 into a JSON error object for client ease-of-use.
|
|
|
|
All litecord errors inherit from the `LitecordError` class, defining things
|
|
on top such as its specific Discord error code and what HTTP status code
|
|
to use.
|
|
|
|
Error messages are documented [here](https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#http).
|