https://github.com/denis-source/notes
https://github.com/denis-source/notes
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/denis-source/notes
- Owner: Denis-Source
- License: gpl-3.0
- Created: 2021-09-10T22:01:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-26T12:40:10.000Z (about 4 years ago)
- Last Synced: 2024-12-28T11:12:11.896Z (over 1 year ago)
- Language: JavaScript
- Size: 8.4 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Notes
## [Django-based](https://www.djangoproject.com/) web application to create post and share notes
***
https://notes.zoloto.cx.ua/
***
Requires registration and login to create, edit and delete notes.
All notes are associated with a user.
Every note can be shared thus making it accessible to everyone.
Shared notes can be liked by the registered users.
Homepage displays shared notes sorted by the [amount of likes](https://notes.zoloto.cx.ua/) or
[creation date](https://notes.zoloto.cx.ua/?sort=date). Registration is not required to view public notes.
Note creation and editing is provided with a rich text editor [TinyMCE](https://pypi.org/project/django-tinymce/).\
Note body contains html but it is always sanitized using [tinyMCE](https://pypi.org/project/django-tinymce/) (both during frontend and form validation) or
[bleach](https://pypi.org/project/bleach/) library if the note is created by API.
Supports all four [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)
[JSON](https://www.json.org/json-en.html) encoded API methods such as GET POST PUT and DELETE.\
more information with examples: https://notes.zoloto.cx.ua/api
Public notes are accessed via an API and do not require authentication; private, on the other hand, can be accessed via
[Session](https://www.django-rest-framework.org/api-guide/authentication/#sessionauthentication) or
[Token](https://www.django-rest-framework.org/api-guide/authentication/#tokenauthentication) authentication.\
Token can be generated on the [profile](https://notes.zoloto.cx.ua/profile) page.
***
Web application consists of:
- [homepage](https://notes.zoloto.cx.ua/) that displays public notes
- [login](https://notes.zoloto.cx.ua/login) and [registration](https://notes.zoloto.cx.ua/register) pages
- [notes list page](https://notes.zoloto.cx.ua/notes) to view user's notes
- [note](https://notes.zoloto.cx.ua/notes/1017) details page
- [note creation and editing](https://notes.zoloto.cx.ua/notes/1017) page
- [profile page](https://notes.zoloto.cx.ua/profile) shows user information, allows it to
change and shows stats about user activity
- [API page](https://notes.zoloto.cx.ua/api)