Public Notes

Navigation

• Project description
• Interface
• Getting started
• Source code
• License

📄 Project description

The website where users can write public notes.

See full description in technical documentation.

📷 Interface

• Main - the main page of the site where all notes are displayed
• About - project information page
• Categories - distribution of notes by category
• Categories list - displaying categories as a list with different levels of nesting
• Authors - list of authors who wrote notes on the site
• Add note - form for adding notes (only for authorized users)
• Search - search by note titles
• <username> - user profile (only for authorized users)

🔨 Getting started - tutorial

💻 Source code

📚 Technical documentation

🔧 Technologies

BackEnd:

• DBMS: PostgreSQL
• Programming language: Python (3.10.4)
• Frameworks and libraries:
  • Django 3.1

FrontEnd:

• Languages: HTML, CSS
• Frameworks and libraries:
  • Bootstrap 5

Tools:

• Docker and Docker compose

☕ Tests

Run all tests:

./publicnotes/manage.py test wall.tests

Using coverage:

coverage run ./publicnotes/manage.py test wall.tests

With report page generation:

coverage run ./publicnotes/manage.py test wall.tests && coverage html

👐 License

Author: Yu-Leo

GNU General Public License v3.0

If you use my code, please put a star ⭐️ on the repository