Skip to content

LesiaUKR/django_sticky_notes_project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

STICKY NOTES APP

A simple and intuitive Django-based web application for creating, reading, updating, and deleting sticky notes. This project demonstrates the implementation of CRUD (Create, Read, Update, Delete) functionality using Django's Model-View-Template (MVT) architecture.


Features

  • Create Notes: Add new sticky notes with a title and content.
  • Read Notes: View a list of all notes and their details.
  • Update Notes: Edit existing notes to update their title or content.
  • Delete Notes: Remove notes that are no longer needed.
  • Unit Tests: Includes comprehensive unit tests for models and views

Technologies Used

  • Backend: Django (Python)
  • Frontend: HTML, CSS, Bootstrap
  • Database: SQLite (default Django database)
  • Testing: Django TestCase

Sticky Notes Application Design

This document describes the design of the Sticky Notes application using Use Case, Sequence, and Class diagrams.

Use Case Diagram

The Use Case Diagram illustrates the main interactions between the user and the system.

use_case_diagram

Sequence Diagram

The Sequence Diagram shows the flow of actions when a user creates a new note

sequence_diagram

Class Diagram

The Class Diagram represents the structure of the application's models and views

class_diagram


Installation

  1. Clone the repository:
    git clone https://github.com/LesiaUKR/django_sticky_notes_project.git
  2. Navigate to the project directory:
cd sticky_notes_django_project
  1. Create a virtual environment and activate it:
python -m venv myenv
source myenv/bin/activate  # On Windows: myenv\Scripts\activate
  1. Install the required dependencies:
pip install -r requirements.txt
  1. Navigate to the sticky_notes directory:
cd sticky_notes

6Apply migrations:

python manage.py migrate
  1. Run the development server:
python manage.py runserver
  1. Open your browser and navigate to http://127.0.0.1:8000.

Running Tests

To run the unit tests, use the following command:

python manage.py test notes

Screenshots

1. Sticky notes list view

sticky_notes_list

2. Sticky notes create/update view

sticky_notes_create_update_view

3. Sticky notes confirm deletion view

sticky_notes_confirm_delete_view

4. Sticky notes tests' results

sticky_notes_test_results

About

DJANGO | Sticky Notes Application

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published