This commit is contained in:
FoxMaSk 2022-10-19 14:57:29 +02:00
parent c025a07207
commit 0d43f436b6
5 changed files with 17 additions and 17 deletions

View File

@ -1,6 +1,6 @@
# ShaarPy
<img src="https://framagit.org/foxmask/shaarpy/-/raw/main/shaarpy/static/shaarpy.png" height="179" width="200"/>
<img src="https://git.afpy.org/foxmask/shaarpy/raw/main/shaarpy/static/shaarpy.png" height="179" width="200"/>
Share Thoughts, Ideas, Links, Notes.
@ -8,7 +8,7 @@ a 'Shaarli cloned' in Python/Django
Have a look at [https://shaarpy.foxmask.org/](https://shaarpy.foxmask.org/) for live instance
![Main page](https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_home.png)
![Main page](https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_home.png)
## Features
@ -18,18 +18,18 @@ Have a look at [https://shaarpy.foxmask.org/](https://shaarpy.foxmask.org/) for
##### Links
- Drop a URL and ShaarPy will grab the article page with **image** and **video** if the source website provides ones
<a href="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article.png"><img src="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article.png" alt="article with image" width="400"/></a>
<a href="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article.png"><img src="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article.png" alt="article with image" width="400"/></a>
##### Tags
- Manage tags
- Tag Cloud
<a href="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/tags_list.png"><img src="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/tags_list.png" alt="tag cloud" width="400"/></a>
<a href="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/tags_list.png"><img src="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/tags_list.png" alt="tag cloud" width="400"/></a>
##### Daily links history
- See the links of the day and navigate throw the calendar to go back to your old links
<a href="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/daily.png"><img src="https://framagit.org/foxmask/shaarpy/-/raw/main/docs/daily.png" alt="daily links" width="400"/></a>
<a href="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/daily.png"><img src="https://git.afpy.org/foxmask/shaarpy/raw/main/docs/daily.png" alt="daily links" width="400"/></a>
##### Tools
- for each link added, a markdown file can be create in a folder that will be sync on your mobile with the help of "[syncthing](https://syncthing.net/)"
@ -50,7 +50,7 @@ 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
![Bookmarklet](https://framagit.org/foxmask/shaarpy/-/raw/main/docs/bookmarklet.png)
![Bookmarklet](https://git.afpy.org/foxmask/shaarpy/raw/main/docs/bookmarklet.png)
Now you'are able to post a new link just be clicking this bookmarklet wherever you are on the web
@ -65,15 +65,15 @@ Then files are generated, you may found them on your mobile (thanks to syncthing
### original webpage
![Link of the website](https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article_website.png)
![Link of the website](https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article_website.png)
### shaarpy grabbed link
![Link in shaarpy](https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article.png)
![Link in shaarpy](https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article.png)
### shaarpy link on mobile
![Shaarpy link on mobile](https://framagit.org/foxmask/shaarpy/-/raw/main/docs/article_mobile.png)
![Shaarpy link on mobile](https://git.afpy.org/foxmask/shaarpy/raw/main/docs/article_mobile.png)
(I use "Epsilon Notes" for that)
@ -107,7 +107,7 @@ source bin/activate
install the project
```bash
git clone https://framagit.org/foxmask/shaarpy
git clone https://git.afpy.org/foxmask/shaarpy
cd shaarpy
```

View File

@ -3,7 +3,7 @@ name=shaarpy
description="ShaarPy: Share your thoughts, links, ideas, notes. If you ever wanted Shaarli in python, that's it ^_*"
author=폭스마스크
author_email=foxmask+git@pm.me
url=https://framagit.org/foxmask/shaarpy
url=https://git.afpy.org/foxmask/shaarpy/
long_description=file: README.md
long_description_content_type=text/markdown
license=WTFPL
@ -23,9 +23,9 @@ classifiers=
Topic :: Database
project_urls =
Documentation = https://framagit.org/foxmask/shaarpy/-/wikis/home
Source = https://framagit.org/foxmask/shaarpy/
Tracker = https://framagit.org/foxmask/shaarpy/-/issues
Documentation = https://git.afpy.org/foxmask/shaarpy/wiki
Source = https://git.afpy.org/foxmask/shaarpy/
Tracker = https://git.afpy.org/foxmask/shaarpy/issues
[options]
python_requires=>=3.8

View File

@ -6,7 +6,7 @@
"tags": "ShaarPy,documentation",
"url": null,
"title": "ShaarPy Project",
"text": "### [ShaarPy](https://framagit.org/foxmask/shaarpy)\r\n\r\n#### Description\r\n\r\nThis project is a clone of the great [Shaarli](https://sebsauvage.net/wiki/doku.php?id=php:shaarli) made in PHP.\r\nThis one is made in [Python](https://www.python.org)3.10 and [Django](https://www.djangoproject.com/) 4.x\r\n\r\n#### The features \r\n\r\n* Notes\r\n* Links\r\n* Tags\r\n\r\n##### Notes\r\n- Create *notes* in **Markdown**\r\n\r\n##### Links\r\n- Drop a URL and ShaarPy will grab the article page with **image** and **video** if the source website provides ones\r\n<a href=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article.png\"><img src=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/shaarpy_article.png\" alt=\"article with image\" width=\"400\"/></a>\r\n\r\n##### Tags\r\n- Manage tags \r\n- Tag Cloud\r\n\r\n<a href=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/tags_list.png\"><img src=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/tags_list.png\" alt=\"tag cloud\" width=\"400\"/></a>\r\n\r\n##### Daily links history\r\n- See the links of the day and navigate throw the calendar to go back to your old links\r\n\r\n<a href=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/daily.png\"><img src=\"https://framagit.org/foxmask/shaarpy/-/raw/main/docs/daily.png\" alt=\"daily links\" width=\"400\"/></a>\r\n\r\n##### Tools\r\n- for each link added, a markdown file can be create in a folder that will be sync on your mobile with the help of \"[syncthing](https://syncthing.net/)\"\r\n- Import of Shaarli exported bookmark\r\n- you can export/import your data in **json** \r\n\r\nexport\r\n```\r\npython manage.py dumpdata --format json --indent 2 > fixtures/my_shaarpy_dump.json\r\n```\r\n\r\nimport\r\n```\r\npython manage.py loaddata --format json fixtures/my_shaarpy_dump.json\r\n```\r\n\r\n#### Installation\r\n\r\nsystem requirements :\r\n\r\n* pandoc\r\n\r\n```\r\napt install pandoc\r\n```\r\n\r\ncreation of a python virtualenv\r\n\r\n\r\ninstall the project\r\n\r\n```\r\ngit clone https://framagit.org/foxmask/shaarpy\r\ncd shaarpy\r\n```\r\n\r\n##### Settings\r\n\r\ncopy the sample config file\r\n\r\n```\r\ncp env.sample .env\r\n```\r\n\r\nand set the following values\r\n\r\n```\r\nSHAARPY_NAME=Home Sweet Links\r\nSHAARPY_DESCRIPTION=Links, tech links, life links\r\n\r\nSECRET=!DONTFORGETTOCHANGETHISVALUE!\r\n\r\nDEBUG=True # or False in prod\r\nDB_ENGINE='django.db.backends.sqlite3'\r\nDB_NAME='db.sqlite3'\r\nDB_USER=''\r\nDB_PASSWORD=''\r\nDB_HOST=''\r\nDB_PORT=''\r\n\r\nTIME_ZONE='Europe/Paris'\r\nLANGUAGE_CODE='en-en'\r\nUSE_I18N=True\r\nUSE_L10N=True\r\nUSE_TZ=True\r\n\r\nSECRET_KEY=!TOBEDEFINED!\r\n```\r\n\r\n##### Database\r\n\r\nsetup the database\r\n\r\n```\r\ncd shaarpy\r\npython manage.py createsuperuser\r\npython manage.py migrate\r\npython manage.py loaddata --format json fixtures/my_shaarpy_dump.json\r\n```\r\n\r\n##### Running the Server\r\n\r\nstart the project\r\n\r\n```\r\npython manage.py runserver localhost:8001\r\n```\r\n\r\nthen, access the project with your browser **http://127.0.0.1:8001/**",
"text": "### [ShaarPy](https://git.afpy.org/foxmask/shaarpy)\r\n\r\n#### Description\r\n\r\nThis project is a clone of the great [Shaarli](https://sebsauvage.net/wiki/doku.php?id=php:shaarli) made in PHP.\r\nThis one is made in [Python](https://www.python.org)3.10 and [Django](https://www.djangoproject.com/) 4.x\r\n\r\n#### The features \r\n\r\n* Notes\r\n* Links\r\n* Tags\r\n\r\n##### Notes\r\n- Create *notes* in **Markdown**\r\n\r\n##### Links\r\n- Drop a URL and ShaarPy will grab the article page with **image** and **video** if the source website provides ones\r\n<a href=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article.png\"><img src=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/shaarpy_article.png\" alt=\"article with image\" width=\"400\"/></a>\r\n\r\n##### Tags\r\n- Manage tags \r\n- Tag Cloud\r\n\r\n<a href=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/tags_list.png\"><img src=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/tags_list.png\" alt=\"tag cloud\" width=\"400\"/></a>\r\n\r\n##### Daily links history\r\n- See the links of the day and navigate throw the calendar to go back to your old links\r\n\r\n<a href=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/daily.png\"><img src=\"https://git.afpy.org/foxmask/shaarpy/raw/main/docs/daily.png\" alt=\"daily links\" width=\"400\"/></a>\r\n\r\n##### Tools\r\n- for each link added, a markdown file can be create in a folder that will be sync on your mobile with the help of \"[syncthing](https://syncthing.net/)\"\r\n- Import of Shaarli exported bookmark\r\n- you can export/import your data in **json** \r\n\r\nexport\r\n```\r\npython manage.py dumpdata --format json --indent 2 > fixtures/my_shaarpy_dump.json\r\n```\r\n\r\nimport\r\n```\r\npython manage.py loaddata --format json fixtures/my_shaarpy_dump.json\r\n```\r\n\r\n#### Installation\r\n\r\nsystem requirements :\r\n\r\n* pandoc\r\n\r\n```\r\napt install pandoc\r\n```\r\n\r\ncreation of a python virtualenv\r\n\r\n\r\ninstall the project\r\n\r\n```\r\ngit clone https://git.afpy.org/foxmask/shaarpy\r\ncd shaarpy\r\n```\r\n\r\n##### Settings\r\n\r\ncopy the sample config file\r\n\r\n```\r\ncp env.sample .env\r\n```\r\n\r\nand set the following values\r\n\r\n```\r\nSHAARPY_NAME=Home Sweet Links\r\nSHAARPY_DESCRIPTION=Links, tech links, life links\r\n\r\nSECRET=!DONTFORGETTOCHANGETHISVALUE!\r\n\r\nDEBUG=True # or False in prod\r\nDB_ENGINE='django.db.backends.sqlite3'\r\nDB_NAME='db.sqlite3'\r\nDB_USER=''\r\nDB_PASSWORD=''\r\nDB_HOST=''\r\nDB_PORT=''\r\n\r\nTIME_ZONE='Europe/Paris'\r\nLANGUAGE_CODE='en-en'\r\nUSE_I18N=True\r\nUSE_L10N=True\r\nUSE_TZ=True\r\n\r\nSECRET_KEY=!TOBEDEFINED!\r\n```\r\n\r\n##### Database\r\n\r\nsetup the database\r\n\r\n```\r\ncd shaarpy\r\npython manage.py createsuperuser\r\npython manage.py migrate\r\npython manage.py loaddata --format json fixtures/my_shaarpy_dump.json\r\n```\r\n\r\n##### Running the Server\r\n\r\nstart the project\r\n\r\n```\r\npython manage.py runserver localhost:8001\r\n```\r\n\r\nthen, access the project with your browser **http://127.0.0.1:8001/**",
"private": false,
"image": null,
"video": null,

View File

@ -33,7 +33,7 @@
</div>
<hr/>
<div class="footer d-flex align-items-center justify-content-center">
<p class="fs-6"><a href="https://framagit.org/foxmask/shaarpy" title="Shaarpy project homepage">ShaarPy</a> - share thoughts, ideas, links, notes - <a title="Shaarpy Documentation" href="https://framagit.org/foxmask/shaarpy/-/blob/main/README.md">documentation</a></p>
<p class="fs-6"><a href="https://git.afpy.org/foxmask/shaarpy" title="Shaarpy project homepage">ShaarPy</a> - share thoughts, ideas, links, notes - <a title="Shaarpy Documentation" href="https://git.afpy.org/foxmask/shaarpy/src/branch/main/README.md">documentation</a></p>
</div>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
</body>

View File

@ -96,7 +96,7 @@
<hr/>
<div class="footer d-flex align-items-center justify-content-center">
{% block footer %}
<p class="fs-6"> <a class="fab fa-python" href="https://framagit.org/foxmask/shaarpy" title="{% trans 'ShaarPy project homepage' %}"> ShaarPy</a> - share thoughts, ideas, links, notes - <a title="Shaarpy Documentation" href="https://framagit.org/foxmask/shaarpy/-/blob/main/README.md">{% trans 'documentation' %}</a></p>
<p class="fs-6"> <a class="fab fa-python" href="https://git.afpy.org/foxmask/shaarpy" title="{% trans 'ShaarPy project homepage' %}"> ShaarPy</a> - share thoughts, ideas, links, notes - <a title="Shaarpy Documentation" href="https://git.afpy.org/foxmask/shaarpy/src/branch/main/README.md">{% trans 'documentation' %}</a></p>
{% endblock %}
</div>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>