Skip to content

Welcome to the One and Done My Journal! This project is a web-based journal and task management application.

Notifications You must be signed in to change notification settings

pviwatkurkul/One-and-Done

 
 

Repository files navigation

One and Done

Welcome to One and Done, a feature-rich journal app built with HTML, CSS, and JavaScript. This app allows you to create notes and folders, use markdown for formatting, and manage tasks efficiently.

HTML5 CSS3 JavaScript

Learn More About our Team!

Team Introduction Video

Project Links

Github GitHub Pages

  • We used Github for project management. Our GitHub Repository has our source code, meeting notes, brainstorming information, kanban board, and much more.
  • We are hosting our website with GitHub Pages.

Features

  • Organized Note and Folder Creation: Easily create and manage your notes and folders to keep your thoughts and tasks well-organized.
  • Markdown Support: Utilize powerful markdown capabilities to format your notes with ease, adding structure and emphasis.
  • Efficient Task List Management: Keep track of your tasks and to-dos effortlessly with a dedicated task list management system.
  • Dual Theme Options: Switch seamlessly between dark mode and light mode to suit your preferences and enhance your writing experience.
  • Persistent Data Management: Rely on local storage to securely manage your data, ensuring your notes and tasks are always saved.
  • Powerful Search Functionality: Quickly find specific notes and tasks with a robust search bar, enhancing productivity and accessibility.
  • Accessibility: Enjoy a user-friendly UI with full keyboard accessibility, ensuring ease of use for everyone.

Brainstorming and Design Process

Dribbble Miro Figma

SimpleMDE API

Markdown

  • We used SimpleMDE's API to implement a markdown editor which includes a tool bar and keyboard shortcuts.

    • Bold: Cmd-B
    • Italic: Cmd-I
    • Link: Cmd-K
    • Preview: Cmd-P
    • Unordered List: Cmd-L
    • Code Block: Cmd-Alt-C
    • Image: Cmd-Alt-I
    • Ordered List: Cmd-Alt-L
    • Heading Bigger: Shift-Cmd-H
    • Heading Smaller: Cmd-H
    • Side By Side: F9
    • Full Screen: F11

CI/CD Pipeline

Github Actions

Our project uses GitHub Actions for Continuous Integration and Deployment. The pipeline includes:

JSDoc

Superlinter

  • Optimization of image,icons, and svg storage quality that are stored on the repo without the loss of quality.

Jest and Puppeteer

Jest

  • For testing purposes.
  • Tests all links that are implemented using Markdown to ensure all links are reachable and valid.
  • Lists and logs all core files that were changed in a specifc branch such as main.

Repository Organization

  • /admin/meetings: Contains our meeting notes.
  • /admin/cipipline: Contains pipeline diagrams.
  • /admin/branding: Continas branding information.
  • /admin/videos: Contains progress videos and final demo video.
  • /admin/guidelines: Contains code style, version control, and CSS style guidelines
  • /docs: Contains JSDoc information.
  • /specs/adrs: Contains Architectural Design Records for any major decisions made in our project.
  • /specs/brainstorm: Contains all of our initial brainstorming from user reasearch to wireframing.
  • /specs/pitch: Contains our intial project pitch.
  • /src: Contains source code for our project.

Wiki

  • To learn more about our project and its development, take a look at our wiki.

Final Project Walkthrough

Project Development Process and Agile Methods

Private Video

Demo Video

Public Video

Known Bugs

  • Markdown plain text centers when previewed
  • Markdown image tag only accepts base64 encodings or any urls without photo classifiers (e.g. jpg, png)
  • Copy and paste for links with photo classifiers does not work, but everything else is valid.

Future Investigation

  • Time Remaining for Task List

    • Calculate and display time remaining for each task.
    • Implement visual representation (countdown clock, progress bar).
  • Calendar Widget

    • Design a tab with an interactive calendar widget.
    • Display notes/tasks due on specific dates.
    • Allow input of daily work hours, displayed on the calendar.
  • Login/Logout Feature

    • Implement user authentication for account creation and login.
    • Design login and sign-in forms.
    • Create a profile page for user information.
    • Ensure security and cross-platform accessibility.
  • Note Entry Templates

    • Implement template selection for notes.
    • Predefined templates: Sprint Review, Standup Meeting, Brainstorming Meeting.

About

Welcome to the One and Done My Journal! This project is a web-based journal and task management application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 68.0%
  • CSS 25.1%
  • HTML 6.9%