Giter VIP home page Giter VIP logo

daptnod's Introduction

daptnod

A shared note maker

languages

last commit

daptnod is a simple Django web application that creates quick notes that can be shared via a url. A more complete alternative to the popular dontpad.com. The implementation strives to be simple and free of unnecessary dependencies.

Example

Goals

  • Easy and quick to create notes
  • It is not necessary to create an account
  • URL for a note is hashed (ex: https://<url_server>/EreQR5z)
  • Possibility to create an account to save notes (differential)
  • Possibility to deprive notes for yourself (differential)
  • Ability to block changing the content of a note (differential)
  • Ability to know when a note was created and the last time it was changed (differential)
  • Ability to know who viewed a note (differential)
  • Search for notes by fragment of content (differential)
  • Adapted for mobile devices (responsive) (differential)
  • Dark mode (differential)

Structure

  • /daptnod/settings/base.py General project settings file
  • /daptnod/settings/heroku.py Production environment settings in heroku
  • /daptnod/urls.py General routing for modules
  • /daptnod/core Module with information shared among other embedded applications
  • /daptnod/accounts Application responsible for user account actions
  • /daptnod/notes Application responsible for managing notes

Instructions

  1. Install Python version 3.8+
  2. Install pip and virtual environment (virtualenv, virtualenvwrapper, pyenv)
  3. Create a virtual environment
  4. Fork and clone repository
  5. pip install -r requirements.txt
  6. make migrations && make migrate
  7. make run
  8. Open http://127.0.0.1:8000/ and verify

Configuration

  • SECRET_KEY Set to specify the secret key used by Django (never share)
  • DEBUG Set to True to show relevant error information (never use True in production)
  • HASHID_FIELD_SALT Set to specify the secret key used by django-hashid-field to create unique hashes for notes (never share)

Dependencies

Project Home Page
Django https://www.djangoproject.com/
Django Debug Toolbar https://django-debug-toolbar.readthedocs.io/en/latest/
django-hashid-field https://pypi.org/project/django-hashid-field/
django-widget-tweaks https://pypi.org/project/django-widget-tweaks/
Gunicorn https://gunicorn.org/
psycopg2-binary https://pypi.org/project/psycopg2-binary/
python-decouple https://pypi.org/project/python-decouple/
whitenoise http://whitenoise.evans.io/en/stable/
Bulma https://bulma.io/
bulma-prefers-dark https://github.com/jloh/bulma-prefers-dark
Pure-Javascript-Toaster-Plugin https://github.com/kvinbabbar/Pure-Javascript-Toaster-Plugin

Contributing

  • Open issue, discuss proposal
  • Fork and clone repository
  • Change code
  • Review changes
  • Send pull request

Others

This project was referenced in the following post in PT-BR: https://diegofernando.dev/criando-uma-ferramenta-para-criacao-de-notas-rapidas.html

License

MIT

daptnod's People

Contributors

diegofsousa avatar

Stargazers

avatar avatar avatar

Watchers

avatar avatar

daptnod's Issues

Email verification when registering

  • After entering the information, the system should send a confirmation email to the user.
  • After the user confirms the email, the system must inform him that his account is active and must suggest that the user enter the system.
  • In the account editing section, if the user changes the email, the system must confirm the change by sending an email to the new address.
  • An email should also be sent to the old address to notify the user of the change.
  • Only users with the "active" flag with a positive value must log in to the system.
  • Until the user confirms the email at the new address, the user must be inactive.

Create basic authentication module

An app accounts must be created with a template with the fields: username, email and password. then it will be discussed whether there will be more fields than the Django stack proposes.

Authentication must allow username or email.

Two-factor authentication

  • While logged in the user may prefer to enable 2FA.
  • A confirmation email must be sent to confirm the action.
  • Once activated, the user must confirm their authenticity by email whenever they enter the system. That is, the system will always send an email to the user to log in through.

Expiration time to be defined.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.