added development instructions to README
This commit is contained in:
parent
4c6ab2d3ae
commit
44cd1308ba
47
README.md
47
README.md
|
@ -152,3 +152,50 @@ less /var/log/syslog
|
|||
# for the nginx web server:
|
||||
less /var/log/nginx/example.org_error.log
|
||||
```
|
||||
|
||||
### Development Install
|
||||
|
||||
If you want to install it locally to develop on it:
|
||||
|
||||
```shell
|
||||
sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python3 nginx git
|
||||
sudo git clone https://github.com/b3yond/ticketfrei
|
||||
cd ticketfrei
|
||||
```
|
||||
|
||||
Install the necessary packages, create and activate virtualenv:
|
||||
|
||||
```shell
|
||||
virtualenv -p python3 .
|
||||
. bin/activate
|
||||
```
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
```shell
|
||||
pip install tweepy pytoml Mastodon.py bottle pyjwt pylibscrypt Markdown
|
||||
```
|
||||
|
||||
Configure the bot:
|
||||
|
||||
```shell
|
||||
cp config.toml.example config.toml
|
||||
vim config.toml
|
||||
```
|
||||
|
||||
This configuration is only for the admin. Users can log into
|
||||
twitter/mastodon/mail and configure their personal bot on the settings page.
|
||||
|
||||
```shell
|
||||
# create folder for socket & database
|
||||
sudo mkdir /var/ticketfrei
|
||||
sudo chown $USER:$USER -R /var/ticketfrei
|
||||
|
||||
# create folder for logs
|
||||
sudo mkdir /var/log/ticketfrei
|
||||
sudo chown $USER:$USER -R /var/log/ticketfrei
|
||||
|
||||
# start Ticketfrei
|
||||
./frontend.py & ./backend.py &
|
||||
```
|
||||
|
||||
|
|
|
@ -41,3 +41,7 @@ input[type=text], input[type=password] {
|
|||
display: inline-block;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
h2 {
|
||||
padding-top: 1em;
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue