How ikitzu/easynotes works
Main Components
• User Interface (Frontend):
• HTML views (e.g., index.html, signup.html)
• CSS assets for styling (files in assets/css)
• JavaScript scripts for dynamic behavior (files in assets/js like script.js, scriptLogin.js, signup.js, and screen.js)
• Client-side Storage:
• Local Storage (current storage mechanism for notes)
• Future API / Backend Service:
• API endpoints to manage notes (create, read, update, delete)
• Authentication logic using JWT (planned feature for securing user accounts)
• Database (to eventually replace Local Storage and store notes securely)
• External Dependencies or Assets:
• Assets such as fonts and images that support the UI
Out Relationships and Interactions
• The user interacts with the web pages (HTML) in the browser.
• The UI layer processes user actions (e.g., note creation, editing, searching) using JavaScript.
• The JavaScript layer reads from and writes to Local Storage to persist data.
• In the near-future architecture, JavaScript will send/receive data via API calls to a backend service.
• The backend will use JWT for authentication, ensuring secure access to the notes.
• A database will store notes and possibly user account information.
Architectural Patterns and Design Principles
• Model-View-Controller (MVC) Approach:
• View: HTML and CSS files that form the presentation layer.
• Controller: JavaScript functions that handle user interactions and data manipulation.
• Model: Data storage represented by Local Storage (with the eventual move to a database in the backend).
• Layered Architectural Design:
• Presentation Layer (Frontend UI)
• Business Logic Layer (JS handling the application logic)
• Data Access Layer (Local Storage now; planned API + database later)
• Progressive Enhancement:
• Start simple (client-side implementation) while anticipating expansion into a full-stack design.
Relevant Technologies
• HTML/CSS/JavaScript as the primary frontend technologies.
• Local Storage for immediate data persistence.
• Planned technologies for backend integration (RESTful API, a database system, and JWT for authentication) as mentioned in the README.
• External assets such as fonts and images to enhance the UI experience.