Share Thoughts, Ideas, Links, Notes.
a 'Shaarli cloned' in Python/Django
export
python manage.py dumpdata --format json --indent 2 > fixtures/my_shaarpy_dump.json
import
python manage.py loaddata --format json fixtures/my_shaarpy_dump.json
Drag the link you'll find under your profile, to the bookmark of the browser
Now you'are able to post a new link just be clicking this bookmarklet wherever you are on the web
If you don't host ShaarPy on a dedicated server, you can run it locally and sync the links in markdown file and sync them on mobile.
Then files are generated, you may found them on your mobile (thanks to syncthing for managing that task)
(I use "Epsilon Notes" for that)
pandoc
sudo apt install pandoc
create a virtualenv
python3 -m venv shaarpy
cd shaarpy
source bin/activate
install the project
git clone https://github.com/foxmask/shaarpy.git
cd shaarpy
copy the sample config file
cp env.sample .env
and set the following values, for examples
# for meta
SHAARPY_NAME=Shaarpy
SHAARPY_DESCRIPTION=Share thoughts, links ideas, notes
SHAARPY_AUTHOR=FoxMaSk
SHAARPY_ROBOT=index, follow
# for MD generation, set a path eg /home/foxmask/MesNotes/links or leave it empty to not use this feature
SHAARPY_LOCALSTORAGE_MD=
SHAARPY_STYLE=blue
SECRET=!DONTFORGETTOCHANGETHISVALUE!
# for production environment, set it to the URL of your 'ShaarPy'
# 1 set it to False
DEBUG=False
# 2 set it to the URL of your 'ShaarPy'
ALLOWED_HOSTS='127.0.0.1,localhost'
# 3 set it to your own domain hosting shaarpy
CSRF_TRUSTED_ORIGINS=https://*.mydomain.com
# for database
DB_ENGINE='django.db.backends.sqlite3'
DB_NAME='db.sqlite3'
DB_USER=''
DB_PASSWORD=''
DB_HOST=''
DB_PORT=''
# i18n/l10n
TIME_ZONE='Europe/Paris'
LANGUAGE_CODE='en-en'
USE_I18N=True
USE_TZ=True
setup the database
cd shaarpy
python manage.py migrate
python manage.py createsuperuser
python manage.py loaddata shaarpy/fixtures/my_shaarpy_data.json
python manage.py runserver localhost:8001
then, access the project with your browser http://127.0.0.1:8001/
python manage.py test
or
pytest
or
coverage run --source='.' -m pytest
coverage report -m
build the image and run the container
sudo docker compose up --build -d
then, the first installation, do:
sudo docker compose exec web python manage.py migrate --noinput
sudo docker compose exec web python manage.py createsuperuser
(logo, thanks to https://pixabay.com/fr/users/clker-free-vector-images-3736/ )