Skip to content

cse110-sp24-group19/final-project

Repository files navigation

🐵 Coding Monkeys present... The Cool Gen Z Work Journal 📝

Project

Docs Codacy

Welcome to The Cool Gen Z Work Journal! This innovative web app is a fun way for users to manage daily tasks, set and achieve goals, and enjoy creative activities, all while earning rewards. Watch your adorable reward character start from an egg and grow up based on your activity in the app!

Videos: Private, Public

Table of Contents

✨ Features

🚀 Main Page

  • Navigation: Easy access to Creative Play, Goal Setting, Rewards, and Calendar/Journal sections.

🗓 Calendar Journal

  • Views:
    • Calendar View: Monthly overview with previews of journal entries.
    • Journal Entry View: Detailed view for managing daily entries.
  • Search: Quickly find entries by title using the search bar in Calendar View.

🎯 Goal Setting

  • Categories: Daily, Weekly, Long-term goals.
  • Functionality: Create, mark as complete, edit, and delete goals with a simple checklist.

🏆 Rewards

  • Character Status: Track your character's progression from egg to adult (Monkey or Dragon).
  • Points System: Earn points by logging in daily and completing tasks. First level-up at 10 points, then every 5 points.
  • Progressions: Automatic character evolution as points accumulate.

🎨 Creative Play

  • Whiteboard: Add text, drawings, and more with p5.js for a creative break.

🌟 Future Features

  • GitHub Integration: Track commits and integrate work logs with journal entries.
  • Labels for Journal Entries: Categorize entries with labels such as Work, School, Personal.
  • Advanced Search: Search entries by date range.

🛠 Setup

To get a local copy up and running, follow these simple steps:

Prerequisites

  • Node.js and npm installed on your machine.

Installation

  1. Clone the repository

    git clone https://github.com/cse110-sp24-group19/final-project.git
  2. Install npm packages

    npm install

🚀 Usage

  1. Main Page:

    • Navigate to different sections: Creative Play, Goal Setting, Rewards, and Calendar/Journal.
  2. Calendar/Journal:

    • Switch between Calendar View and Journal Entry View to manage your entries.
    • Use the search bar in Calendar View to find specific entries by title.
  3. Goal Setting:

    • Add new goals, mark them as complete, edit, or delete them.
  4. Rewards:

    • Track your character's progress and evolution.
    • Earn points by logging in daily and completing tasks.
  5. Creative Play:

    • Use the whiteboard to draw, write, and create freely.

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch
    git checkout -b feature/AmazingFeature
  3. Commit your Changes
    git commit -m 'Add some AmazingFeature'
  4. Push to the Branch
    git push origin feature/AmazingFeature
  5. Open a Pull Request

For detailed information, refer to our Developer Guide.

👥 Project Team

Team Leads

  • Riana Ali
  • Milana Gorobchenko

Developers

  • Julie Hong
  • Allison Lane
  • Wenzhe Xu
  • Brandon Panuco
  • Charlie Trinh
  • David De-santiago
  • Julio Rivas Midence
  • Ginger Smith
  • Nikolas Yanek-Chrones

TA

  • Kashish Jain

📧 Contact

For more information, contact riali@ucsd.edu or mgorobchenko@ucsd.edu.


Thank you for checking out The Cool Gen Z Work Journal! We hope you find it as fun and useful as we do.