The "Short Note Hub" is a web application designed for managing brief notes. Users can create, view (via a unique link), edit, and delete their own notes within the system. Each note is limited to a maximum length of 404 characters. This service provides a user-friendly platform for quick note-taking and organization, allowing individuals to efficiently capture and manage concise pieces of information tailored to their needs.
-
Create Notes:
- Users can create short notes, capturing important information or ideas quickly.
-
View Notes via Link:
- Each note is accessible through a unique link, facilitating easy sharing with others.
-
Edit Notes:
- Users have the ability to modify the content of their notes as needed.
-
Delete Notes (User-Specific):
- Users can delete their own notes, providing control over their personal content.
-
Note Length Limitation:
- The length of each note is restricted to a maximum of 404 characters, encouraging brevity.
To run the Short Note Hub locally, follow these steps:
-
Clone the Repository::
git clone https://github.com/sofibrezden/Short-Note-Hub.git cd short-note-hub -
Create a virtual environment to install dependencies in and activate it:
virtualenv2 --no-site-packages env source env/bin/activate -
Install Dependencies:
pip install -r requirements.txt -
Run Migrations:
python manage.py migrate -
Start the Server:
python manage.py runserver -
Start Web Server:
npm start -
Access the Application:
Open your web browser and go to http://localhost:3000 to interact with the Short Note Hub.
Example of using:
http://127.0.0.1:3000
Example of using:
http://127.0.0.1:3000/login/
Example of using:
http://127.0.0.1:3000/register/
Example of using:
http://localhost:3000/share/
Example of using:
http://localhost:3000/statistics/
User Authentication
/register/: User registration view./login/: User login view./logout/: User logout view.
Note Management
/notes/: View to display user-specific notes./create_note/: View for creating a new note./edit_note/<int:id>/: View for editing an existing note./view_note/<int:id>/: View for viewing details of a specific note./notes/<int:note_id>/share/: View for sharing access to a specific note./delete_note/<int:id>/: View for deleting a specific note.
Shared Notes
/shared_notes/: View to display notes shared with the user.
User Statistics
/statistics/: View to display user-specific statistics.
Admin Panel
/admin/: Admin panel is accessible at /admin/, providing a centralized interface for managing the application.
This example assumes that your Django development server is running locally on http://127.0.0.1:3000/. Make sure to adjust the URLs accordingly if your setup is different.