In today's digital age, maintaining a productive lifestyle and balancing mental wellness poses a significant challenge. Traditional methods, such as carrying a physical journal, are becoming outdated and inconvenient. The Developer Journal by Team 25: Git Gremlins, is a web application designed to address these challenges by providing an integrated, efficient, and accessible solution for managing personal productivity and mental health.
Our project aims to solve the following problems:
- Productivity Management: Keeping track of tasks and reminders in a structured and easily accessible manner.
- Mental Wellness: Promoting self-reflection and growth by organizing thoughts and emotions through journaling.
- Convenience: Eliminating the need to carry a physical journal and integrating seamlessly with digital tools.
The Developer Journal offers a comprehensive suite of features to help users manage their daily productivity and mental wellness effectively:
- Journaling: Users can make daily journal entries that are stored and associated with the respective day, allowing for easy retrieval and review.
- Sentiment and Productivity Rating: Users can rate their mood and productivity each day, with these ratings being stored and associated with the journal entries.
- Task Management: Users can create, edit, delete, and complete tasks. Completed tasks are associated with the specific day they were completed.
- Calendar Integration: The calendar allows users to view past entries, tasks, and ratings, providing a comprehensive overview of their past activities and mental state.
- Journaling:
- Daily entries stored with timestamps
- Easy retrieval and review of past entries
- Sentiment and Productivity Rating:
- Users rate their daily mood and productivity
- Ratings stored with corresponding journal entries
- Task Management:
- Simple task creation and management
- Tasks can be marked as completed, edited, or deleted
- Completed tasks linked to the day they were accomplished
- Calendar:
- View past journal entries, tasks, and ratings
- Calendar displays a summary of past activities and sentiments
- Frontend: Developed using HTML, CSS, and JavaScript for a responsive and user-friendly interface.
- Backend and Storage: Utilizes LocalStorage to store user data locally on their device in JSON format.
- Testing Framework:
- HTML & CSS: Ensures responsiveness across various screen sizes and tests performance using LightHouse.
- JavaScript: Unit testing with Jest to ensure functionality and reliability and used Puppeteer to perform E2E testing, simulating real-world user scenarios to ensure application functions as expected from start to finish.
- Responsiveness: Ensures the application works seamlessly across different devices and screen sizes.
- Performance: Lightweight design with local storage to maintain high performance.
- Accessibility: Adheres to good HTML practices for compatibility with screen readers and keyboard navigation.
- Usability: Intuitive UI design following common standards to enhance user experience.
- Satisfaction: Focused on aesthetic appeal and convenience to ensure user satisfaction.
To install the journal app, simply clone this repository to your local machine:
git clone https://github.com/cse110-sp24-group25/cse110-sp24-group25.git
No additional dependencies are required. You can then open the homepage.html file in your web browser to locally use the journal.
If you'd like to contribute to this project, feel free to submit bug reports, feature requests, or pull requests through GitHub. Please follow our Contributing Guidelines.
This journal app was created by Git Gremlins.
| Name | Github |
|---|---|
| Andrew | Andrewphanguyen |
| Kevin | radiomediocre |
| Chris | ChEdwards492 |
| Bobby | BobbyYuuu |
| Sonya | KimSeongah |
| Kai | kaiwoessner |
| Sahana | sahananar |
| Derek | dklopstein |
| Nathan | NathanD0wd |
| Justin | jjustinyyang |