mirror of https://gitlab.com/litecord/litecord.git
rewrite readme
This commit is contained in:
parent
4a658aec95
commit
f463d6c934
32
README.md
32
README.md
|
|
@ -1,37 +1,41 @@
|
||||||
# litecord
|
# litecord
|
||||||
|
|
||||||
Litecord is a free as in freedom implementation of Discord's backend services.
|
Litecord is an open source implementation of Discord's backend and API in
|
||||||
|
Python.
|
||||||
|
|
||||||
|
This project is a rewrite of [litecord-reference].
|
||||||
|
|
||||||
Rewrite of [litecord-reference].
|
|
||||||
[litecord-reference]: https://gitlab.com/lnmds/litecord-reference
|
[litecord-reference]: https://gitlab.com/lnmds/litecord-reference
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
- Python 3.6 or higher
|
- Python 3.6 or higher
|
||||||
- PostgreSQL
|
- PostgreSQL
|
||||||
|
- [Pipenv]
|
||||||
|
|
||||||
We use [pipenv] to manage our dependencies.
|
|
||||||
[pipenv]: https://github.com/pypa/pipenv
|
[pipenv]: https://github.com/pypa/pipenv
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ git clone https://gitlab.com/lnmds/litecord
|
$ git clone https://gitlab.com/lnmds/litecord.git && cd litecord
|
||||||
$ cd litecord
|
|
||||||
|
|
||||||
# create users as you want, etc
|
# Setup the database:
|
||||||
$ psql -U some_user -f schema.sql database
|
$ createdb litecord
|
||||||
|
$ psql -f schema.sql litecord
|
||||||
|
|
||||||
# edit config.py as you please
|
# Configure litecord:
|
||||||
$ cp config.example.py config.py
|
$ cp config.example.py config.py
|
||||||
|
|
||||||
# install all packages, including dev-packages
|
# Install all packages:
|
||||||
$ pipenv install --dev
|
$ pipenv install --dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
```
|
Hypercorn is used to run litecord. By default, it will bind to `0.0.0.0:5000`.
|
||||||
# hypercorn will by default bind to 0.0.0.0:5000, change that address
|
You can use the `-b` option to change it (e.g. `-b 0.0.0.0:45000`).
|
||||||
# with the -b option (e.g -b 0.0.0.0:6969).
|
|
||||||
# use '--access-log -' to show logs on stdout.
|
Use `--access-log -` to output access logs to stdout.
|
||||||
|
|
||||||
|
```sh
|
||||||
$ pipenv run hypercorn run:app
|
$ pipenv run hypercorn run:app
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue