https://github.com/dimplektech/django
https://github.com/dimplektech/django
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dimplektech/django
- Owner: Dimplektech
- Created: 2024-05-25T11:07:35.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T10:10:30.000Z (about 2 years ago)
- Last Synced: 2025-01-30T08:43:30.337Z (over 1 year ago)
- Language: Python
- Size: 152 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sticky Notes Apllication
In this README file:
- **Project Overview** gives a brief introduction to the project.
- **Features** lists the key functionalities of the project.
- **Installation** provides step-by-step instructions to set up the project locally.
- **Usage** explains how to access and use the application.
- **Models** and **Views** sections give details about the database models and the main views in the application.
- **Credits**
Project Overview
Sticky Note Application is Web application designed using django, Pthon and SQLite to help user to create Notes efficiently. It allows users to create, update, delete, and view Notes. This application is important for learning fundamental DJango, CRUD (Create, Read, Update, Delete) and creating Database in SQlite. It also allows user to nevigate to one page to another page for view and edit notes.
Features
Create New Sticky Notes with title and body:
Add a new Note with a title and Content.
View a List of Notes:
See a list of all Notes.
View Note:
View details of perticular note.
Edit existing Notes:
Edit the details of an existing Note.
Delete Note:
Delete a Note from the list.
## Installation
1. **Clone the repository:**
```sh
git clone https://github.com/Dimplektech/Django.git
cd sticky-notes-app
```
2. **Create and activate a virtual environment:**
```sh
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install the required dependencies:**
```sh
pip install -r requirements.txt
```
4. **Apply migrations:**
```sh
python manage.py migrate
```
5. **Run the development server:**
```sh
python manage.py runserver
```
Usage>
1. To verify the Sticky_notes project, make sure your virtual environment is activated, then start Django's development server using the command
python manage.py runserver
. The server runs on the default port 8000, and you see output like the following output in the terminal window
(django_venv) PS C:\Users\Simran\OneDrive\Desktop\Python_bootcamp\Task24_Django> cd sticky_notes
(django_venv) PS C:\Users\Simran\OneDrive\Desktop\Python_bootcamp\Task24_Django\sticky_notes> py manage.py runserver
Watching for file changes with StatReloader
Performing system checks...
System check identified no issues (0 silenced).
June 07, 2024 - 09:03:57
Django version 5.0.6, using settings 'sticky_notes.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.
2. CTRL + click http://127.0.0.1:8000/ and page will be open on the browser and ayou will be navigate to Main screen. On Main Screen You can see list of all Notes.
There is button to Add button to add new Notes.
TO edit Notes you need to click on perticular note.
3. To add new Note ,Click on Add button,it will nevigate you to another page to add note.
4. Edit Note : Click on one of the note,it will take you to detail page where you can see details of perticular note and u can click edit.
5.This page to Edit Perticulat Note.Once u save it will take you to detail page of that note.
6. Delete button will delete peticular note and navigate you to Home Page.
7. Back to notes button will take you to home page where you can see list of notes.
## Model
### Notes
- `title`: The title of the note.
- `content`: The content of the note.
- `created_at`: Timestamp when the note was created.
- `updated_at`: Timestamp when the note was last updated.
## Views
### Notes Views
- `note_list`: Displays a list of all notes.
- `note_detail`: Displays details of a specific note.
- `note_new`: Form to create a new note.
- `note_edit`: Form to edit an existing note.
- `note_delete`: Deletes a specified note.
Credits
Author: Dimpal Kaware
Repository: https://github.com/Dimplektech