Creation and management of simple notes by Thabo Tankiso Thebe.
- Document Version History
- Signed Off By
- Contributors
- Current Features Analysis
- High-level Description
- Systems Involved
- Process Flow
- Detailed Steps
- Possible Exceptions
Version | Author | Date |
---|---|---|
1.x | Tankiso Thebe | 02/05/2024 |
Name | Function | Responsibility
Name | Function | Responsibility |
---|---|---|
Tankiso Thebe | Software Developer | Develop |
Lebohang Thokoane | Quality Assurance | Test the app |
The application allows different users to create, read, and manage notes. Admin users have additional capabilities to manage user accounts and notes. Currently, normal users can:
- Register for SmartNotes account.
- Login into SmartNotes.
- Create a note.
- Read a note.
- Update a note.
- Delete a note.
- Share a note.
System | Used for | User role needed |
---|---|---|
Django Admin | Manage the SmartNotes application users and notes | Admin access |
Notes | Displaying and managing notes for logged-in users | User account (username and password) |
Home | Main or landing page for the app | Any |
Here is a description of the process in the form of a flow chart:
graph LR
A[Register] --> B[Login] --> C[Create/Share a note]
B --> D[Read a Note]
B --> E[Update a Note/Share a note]
B --> F[Delete a Note]
- The URL used by the user is:
http://smartnotes.local:8000/
- The URL used by the user is:
http://smartnotes.local:8000/register
- User can create personal credentials (a username and a password).
- The URL used by the user is:
http://smartnotes.local:8000/login
- User enters their personal credentials (a username and a password).
- After logging into the site, the user inserts a title, content and category for the note.
- A User can choose to share a note with other users of their choice or not share.
- User saves the note.
- After creating or if another user shares a note, the user can see their note listed under "Notes" or "Shared Notes".
- User can read/see their notes by clicking on the note's title.
- After creating a note, the user can edit their note and update it.
- While editing the user can also choose to share the note with other users.
- After creating a note, the user can delete it.
Exceptions are special cases and rules that can influence and even stop the smooth running of the SmartNotes app.
- Missing Data: Username, password, note title, and notes content are all required. If some of this information is missing, the user will not be able to login or create a note.
- Invalid Credentials: If the user provides invalid credentials, the login is not successful, and the process stops.
This is a django project