https://github.com/snikket-im/snikket-web-portal

This is the web portal for Snikket Chat services. To learn more about what Snikket Chat services are, check the website.
https://github.com/snikket-im/snikket-web-portal

snikket

Last synced: 2 months ago
JSON representation

This is the web portal for Snikket Chat services. To learn more about what Snikket Chat services are, check the website.

• Host: GitHub
• URL: https://github.com/snikket-im/snikket-web-portal
• Owner: snikket-im
• License: agpl-3.0
• Created: 2020-02-17T16:10:41.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T17:05:18.000Z (9 months ago)
• Last Synced: 2024-05-21T11:18:47.789Z (8 months ago)
• Topics: snikket
• Language: Python
• Homepage: https://snikket.org
• Size: 4.19 MB
• Stars: 31
• Watchers: 6
• Forks: 13
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Snikket Web Portal

![Screenshot of the app](docs/readme-screenshot.png)

## Development quickstart

```console

$ direnv allow

$ cp example.env .env

$ $EDITOR .env  # to adapt the configuration to your needs

$ pip install -r requirements.txt

$ pip install -r build-requirements.txt

$ make

$ quart run

```

## Configuring

### Purely via environment variables

For a list of required and understood environment variables as well as their

semantics, please refer to [`example.env`](example.env).

### Via python code

In addition to statically setting environment variables, it is possible to

initialise the environment variables in a python file. To do that, pass the

path to the python file as `SNIKKET_WEB_PYENV` environment variable.

The python file is evaluated before further environment variable processing

takes place. Every name defined in that file which begins with an upper case

ASCII letter is included in the processing of environment variables for

configuration purposes.

For a (non-productive) example of such a file, see `example.env.py`.