mcieciora/GracefulServal

What is GracefulServal

Graceful Serval is a bookmarks tool, which helps to establish register of interesting or useful websites in you local network. It may be helpful for you, your family, friends, flatmates or even coworkers to keep helpful content in one place.

About Serval

Serval (Felis serval) is a long-legged African wildcat having large ears and a tawny black-spotted coat. Servals are extinction threatened, but only 9 out of 42 countries, where servals occur, have banned hunting for their leather. On many European e-commerce websites there is possibility to find offers for buying servals as pets. This animal was chosen as mascot for this project to raise awareness, that even if international law prohibits some actions, not all countries take care of animals, that are on edge of extinction, cause for many people lust for money is stronger than morality.

source: Serval - Wikipedia

Discontinuation note

This project is currently discontinued, because author has no further plans for application development. Similar projects may be started in the future, but as far as this note is available here, probably none did.

How to install

Prerequisites

Python version: >= 3.7

Python modules (list available in requirements.txt):

flask~=1.1.2  
Flask-SQLAlchemy  
Flask-Login  
Werkzeug~=1.0.1  
SQLAlchemy~=1.3.23  
requests~=2.25.1  
waitress

See: How to install modules
See: How to install modules from requirements.txt

Docker container

Get graceful_serval container with:

docker run -d -p 8000:8000 --name graceful_serval mcieciora/graceful_serval:latest

Step-by-step installation

Supported OS: Ubuntu 20.04

1. Clone repository

git clone https://github.com/mcieciora/GracefulServal.git
cd GracefulServal

2. Create service file in /lib/systemd/system

sudo nano /lib/systemd/system/graceful_serval.service

3. Write into /lib/systemd/system

[Unit]  
Description=Graceful Serval Service  
After=multi-user.target  

[Service]  
Type=idle  
User=<YOUR_USER_NAME>  
Group=<YOUR_USER_GROUP>  
ExecStart=<PATH_TO_PYTHON> <PATH TO CLONED REPOSITORY>/main.py  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

4. Set access rights

sudo chmod 644 /lib/systemd/system/graceful_serval.service

5. Start daemon

sudo systemctl daemon-reload
sudo systemctl enable graceful_serval.service

6. Reboot machine

sudo reboot

How to use

Sing up

First, you need to create account with username and pin code as a password. Pin code shall be four digits long. After submitting, you will be automatically redirected to Home page again, which now will contain url addition form.